Struct starlark::environment::Module

pub struct Module { /* private fields */ }

A container for user values, used during execution.

A module contains both a FrozenHeap and Heap on which different values are allocated. You can get references to these heaps with frozen_heap and heap. Be careful not to use these values after the Module has been released unless you obtain a reference to the frozen heap.

Implementations

impl Module

pub fn new() -> Self

Create a new module environment with no contents.

pub fn heap(&self) -> &Heap

Get the heap on which values are allocated by this module.

pub fn frozen_heap(&self) -> &FrozenHeap

Get the frozen heap on which frozen values are allocated by this module.

pub fn names(&self) -> impl Iterator<Item = FrozenStringValue> + '_

Iterate through all the names defined in this module. Only includes symbols that are publicly exposed.

pub fn names_and_visibilities( &self ) -> impl Iterator<Item = (FrozenStringValue, Visibility)> + '_

Iterate through all the names defined in this module, including those that are private.

pub fn get<'v>(&'v self, name: &str) -> Option<Value<'v>>

Get the value of the exported variable name. Returns None if the variable isn’t defined in the module or it is private.

pub fn freeze(self) -> Result<FrozenModule>

Freeze the environment, all its value will become immutable afterwards.

pub fn set<'v>(&'v self, name: &str, value: Value<'v>)

Set the value of a variable in the environment. Modifying these variables while executing is ongoing can have surprising effects.

pub fn import_public_symbols(&self, module: &FrozenModule)

Import symbols from a module, similar to what is done during load().

pub fn set_extra_value<'v>(&'v self, v: Value<'v>)

Field that can be used for any purpose you want.

pub fn extra_value<'v>(&'v self) -> Option<Value<'v>>

Field that can be used for any purpose you want.

Trait Implementations

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Self

Returns the “default value” for a type.