Struct starlark::environment::FrozenModule

pub struct FrozenModule { /* private fields */ }

The result of freezing a Module, making it and its contained values immutable.

The values of this FrozenModule are stored on a frozen heap, a reference to which can be obtained using frozen_heap. Be careful not to use these values after the FrozenModule has been released unless you obtain a reference to the frozen heap.

Implementations

impl FrozenModule

pub fn dump_debug(&self) -> String

Print a lot of module internals for debugging.

impl FrozenModule

pub fn get(&self, name: &str) -> Option<OwnedFrozenValue>

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 names(&self) -> impl Iterator<Item = &str>

Iterate through all the names defined in this module.

pub fn frozen_heap(&self) -> &FrozenHeapRef

Obtain the FrozenHeapRef which owns the storage of all values defined in this module.

pub fn describe(&self) -> String

Print out some approximation of the module definitions.

pub fn documentation(&self) -> Option<DocItem>

Fetch the documentation for the module.

pub fn module_documentation(&self) -> ModuleDocs

The documentation for the module, and all of its top level values

Returns (, { : <that symbol’s documentation> })

Trait Implementations

impl Clone for FrozenModule

fn clone(&self) -> FrozenModule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrozenModule

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

Formats the value using the given formatter.

impl Dupe for FrozenModule

fn dupe(&self) -> Self