Interface AmbientScope

A scoped state change (withr, rlang): with_* undoes it after its code, local_* when the calling function returns.

interface AmbientScope {
    code?: string;
    new?: string;
    params: readonly string[];
    preserve?: boolean;
    state: Option | Env | Locale | AmbientSingleState;
}

Properties

code?: string

the formal evaluated with the change in effect, absent for the local_* variants

new?: string

the formal holding a list of the new values (list(digits = 3)), other named arguments are values too

params: readonly string[]

the formals in order, used to bind the arguments

preserve?: boolean

the scope changes nothing, it only restores the state afterward (with_preserve_seed)

the state the scope changes; the keyed ones (options, environment variables, locale) take the entries the call names