Struct starlark::environment::GlobalsBuilder

pub struct GlobalsBuilder { /* private fields */ }

Used to build a Globals value.

Implementations

impl GlobalsBuilder

pub fn new() -> Self

Create an empty GlobalsBuilder, with no functions in scope.

pub fn standard() -> Self

Create a GlobalsBuilder following the Starlark standard.

pub fn extended() -> Self

Create a GlobalsBuilder combining those functions in the Starlark standard plus all those defined in LibraryExtension.

pub fn extended_by(extensions: &[LibraryExtension]) -> Self

Create a GlobalsBuilder combining those functions in the Starlark standard plus all those defined in LibraryExtension.

pub fn struct_(&mut self, name: &str, f: impl Fn(&mut GlobalsBuilder))

Add a nested struct to the builder. If f adds the definition foo, it will end up on a struct name, accessible as name.foo. This function cannot be called recursively from inside f.

pub fn with(self, f: impl FnOnce(&mut Self)) -> Self

A fluent API for modifying GlobalsBuilder and returning the result.

pub fn with_struct(self, name: &str, f: impl Fn(&mut GlobalsBuilder)) -> Self

A fluent API for modifying GlobalsBuilder using struct_.

pub fn build(self) -> Globals

Called at the end to build a Globals.

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

Set a value in the GlobalsBuilder.

pub fn set_function<F>(
    &mut self,
    name: &str,
    speculative_exec_safe: bool,
    raw_docs: NativeCallableRawDocs,
    typ: Option<FrozenValue>,
    f: F
) where
    F: for<'v> Fn(&mut Evaluator<'v, '_>, &Arguments<'v, '_>) -> Result<Value<'v>> + Send + Sync + 'static, 

Set a method. This function is usually called from code generated by starlark_derive and rarely needs to be called manually.

pub fn alloc<'v, V: AllocFrozenValue>(&'v self, value: V) -> FrozenValue

Allocate a value using the same underlying heap as the GlobalsBuilder, only intended for values that are referred to by those which are passed to set.

pub fn set_docstring(&mut self, docstring: &str)

Set per module docstring.

This function is called by the starlark_derive generated code and rarely needs to be called manually.

Trait Implementations

impl Debug for GlobalsBuilder

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

Formats the value using the given formatter.