return_from: Jump to or from a frame

In rlang: Functions for Base Types and Core R and 'Tidyverse' Features

Jump to or from a frame

Description

While base::return() can only return from the current local frame, return_from() will return from any frame on the current evaluation stack, between the global and the currently active context.

Usage

return_from(frame, value = NULL)

Arguments

frame	An execution environment of a currently running function.
value	The return value.

Examples

fn <- function() {
  g(current_env())
  "ignored"
}
g <- function(env) {
  h(env)
  "ignored"
}
h <- function(env) {
  return_from(env, "early return")
  "ignored"
}

fn()

rlang documentation built on June 22, 2024, 9:31 a.m.