Struct starlark::environment::MethodsBuilder

pub struct MethodsBuilder { /* private fields */ }

Used to build a Methods value.

Implementations

impl MethodsBuilder

pub fn new() -> Self

Create an empty MethodsBuilder, with no functions in scope.

pub fn build(self) -> Methods

Called at the end to build a Methods.

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

A fluent API for modifying MethodsBuilder and returning the result.

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

Set the raw docstring for this object.

pub fn set_attribute<'v, V: AllocFrozenValue>(
    &'v mut self,
    name: &str,
    value: V,
    docstring: Option<String>
)

Set a constant value in the MethodsBuilder that will be suitable for use with StarlarkValue::get_methods.

pub fn set_attribute_fn<F>(
    &mut self,
    name: &str,
    speculative_exec_safe: bool,
    docstring: Option<String>,
    typ: String,
    f: F
) where
    F: for<'v> Fn(Value<'v>, &'v Heap) -> Result<Value<'v>> + Send + Sync + 'static, 

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

pub fn set_method<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, '_>, Value<'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 MethodsBuilder

Trait Implementations

impl Debug for MethodsBuilder

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

Formats the value using the given formatter.