R: Restarts utilities

rst_list {rlang} | R Documentation

## Restarts utilities

### Description

Restarts are named jumping points established by `with_restarts()`. `rst_list()` returns the names of all restarts currently established. `rst_exists()` checks if a given restart is established. `rst_jump()` stops execution of the current function and jumps to a restart point. If the restart does not exist, an error is thrown. `rst_maybe_jump()` first checks that a restart exists before jumping.

### Usage

    rst_list()

    rst_exists(.restart)

    rst_jump(.restart, ...)

    rst_maybe_jump(.restart, ...)

### Arguments

`.restart` | The name of a restart.
`...` | Arguments passed on to the restart function. These dots support tidy dots features.

### Life cycle

All the restart functions are in the questioning stage. It is not clear yet whether we want to recommend restarts as a style of programming in R.

### See Also

`with_restarts()`

[Package rlang version 0.3.2 Index]