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 from_globals(globals: &Globals) -> Result<FrozenModule>

Convert items in globals into a FrozenModule. This function can be used to implement starlark module using the #[starlark_module] attribute.

This function does not return an error, but we prefer not to panic if there’s some high level logic error.

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

Get the value of the exported variable name.

Returns

• None if symbol is not found
• error if symbol is private

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

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

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 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) -> DocModule

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

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

pub fn aggregated_heap_profile_info(&self) -> Result<&AggregateHeapProfileInfo>

Retained memory info, or error if not enabled.

pub fn heap_profile(&self) -> Result<ProfileData>

Retained memory info, or error if not enabled.

pub fn extra_value(&self) -> Option<FrozenValue>

extra_value field from Module, frozen.

pub fn owned_extra_value(&self) -> Option<OwnedFrozenValue>

extra_value field from Module, frozen.

Trait Implementations

impl Allocative for FrozenModule

fn visit<'allocative_a, 'allocative_b: 'allocative_a>( &self, visitor: &'allocative_a mut Visitor<'allocative_b> )

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