Variable AmbientStateName

Type Declaration

• allOf: function

  • allOf(this: void, state: KeyedState): AmbientStateName

    the pseudo variable every write to the state adds to, like #env

    Parameters

    • this: void
    • state: KeyedState

    Returns AmbientStateName

• ReadonlyallOptions: "#options"

  every option write, for readers that may read any option (getOption(k) with an unknown k, library functions)

• ReadonlyanyFile: "#file:*"

  written by a call writing a file we cannot name, which every call reading a file reads

• Readonlycanvas: "#canvas"

  what is drawn on the active device, which every plot adds to; only written if semantics.ambient.drawingWritesDevice is set

• Readonlydevice: "#device"

  the call that opened the active device, and those of the other open devices

• ReadonlydeviceOpenedHere: "#device:here"

  within a function, the call of its body that opened the active device, which only that body knows

• file: function

  • file(this: void, stem: string): AmbientStateName

    the file named stem (data for out/data.csv), so a read of a named file only sees writes that may hit it

    Parameters

    • this: void
    • stem: string

    Returns AmbientStateName

• Readonlyfiles: "#files"

  the files on disk, which every call writing a file adds to and every call reading a file we cannot name reads

• Readonlyfinalizers: "#finalizers"

  the finalizers registered (reg.finalizer) and the removals that may release their objects, which gc() may run

• Readonlygraphics: "#graphics"

  the graphics state (par, layout, ...) of the active device, which a new device starts afresh

• is: function

  • is(this: void, name: Identifier | undefined): name is AmbientStateName

    whether name is one of these pseudo variables

    Parameters

    • this: void
    • name: Identifier | undefined

    Returns name is AmbientStateName

• keyed: function

  • keyed(this: void, state: KeyedState, key: BrandedIdentifier): AmbientStateName

    the pseudo variable of the entry key of a state, like #env:PATH; setting the entry replaces it

    Parameters

    • this: void
    • state: KeyedState
    • key: BrandedIdentifier

    Returns AmbientStateName

• ReadonlylibPaths: "#lib-paths"

  where packages are installed and loaded from, which .libPaths(new) changes and every package load reads

• option: function

  • option(this: void, key: BrandedIdentifier): AmbientStateName

    the pseudo variable holding the option key; setting the option replaces it

    Parameters

    • this: void
    • key: BrandedIdentifier

    Returns AmbientStateName

• ReadonlyotherDevices: "#graphics:other"

  the graphics states of the other open devices, the active one returns to one of them once it closes

• ReadonlyotherDevicesOpenedBy: "#device:other"

• Readonlypalette: "#palette"

  the color palette, which, other than the graphics parameters, all devices share

• ReadonlyprojectRoot: "#project-root"

  the project root here::here() builds its paths from, found from the working directory unless here::i_am names it

• Readonlyrng: "#rng"

  the state of the random number generator, which set.seed sets and every draw advances

• ReadonlyrngKind: "#rng:kind"

  the kind of generator, which set.seed keeps unless it is given one

• ReadonlyrngVariable: ".Random.seed"

  the global variable R keeps that state in, so assigning it sets AmbientStateName.rng as well

• Readonlysink: "#sink"

  whether console output is diverted into a file or connection, as sink(file) does and sink() undoes

• textConnection: function

  • textConnection(this: void, name: BrandedIdentifier): AmbientStateName

    marks name as bound to a text connection opened for writing, whose writes change it

    Parameters

    • this: void
    • name: BrandedIdentifier

    Returns AmbientStateName

• Readonlyumask: "#umask"

  the file creation mask Sys.umask sets

• ReadonlyunknownOption: "#option:*"

  written by an options(...) call whose keys we cannot name, like the common options(op) restore

• ReadonlywarnsAsErrors: "#warn-error"

  written along with the option warn when it may turn warnings into errors (warn >= 2)

• ReadonlyworkingDirectory: "#wd"

  the working directory setwd changes, which every call accessing a file reads to resolve a relative path