Struct artichoke_backend::state::State

pub struct State {
    pub parser: Option<State>,
    pub classes: Registry,
    pub modules: Registry,
    pub vfs: Adapter,
    pub regexp: State,
    pub symbols: SymbolTable,
    pub output: Strategy,
    pub prng: Random,
}

Container for interpreter global state.

A Ruby interpreter requires various pieces of state to execute Ruby code. It needs an object heap, type registry, symbol table, psuedorandom number generator, and more.

This struct stores all of these components and allows them to be passed around as one bundle. This is useful in FFI contexts because this State can be Boxed and stored in a user data pointer.

Fields

parser: Option<State>

classes: Registry

modules: Registry

vfs: Adapter

regexp: State

symbols: SymbolTable

output: Strategy

prng: Random

Implementations

impl State

pub fn new() -> Result<Self, InterpreterAllocError>

Create a new State.

The state is comprised of several components:

• Class and Module registries.
• Regexp global state.
• In-memory virtual filesystem.
• Ruby parser and file context.
• Intepreter-level PRNG (requires activating the core-random feature).
• IO capturing strategy.

Errors

If the core-random feature is enabled, this function may return an error if the interpreter-global psuedorandom number generator fails to initialize using the platform source of randomness.

Trait Implementations

impl Debug for State

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.