Struct starlark::eval::ParametersSpec

#[repr(C)]
pub struct ParametersSpec<V> { /* fields omitted */ }

Define a list of parameters. This code assumes that all names are distinct and that *args/**kwargs occur in well-formed locations.

Implementations

impl<V> ParametersSpec<V>

pub fn new(function_name: String) -> Self

Create a new ParametersSpec with the given function name.

pub fn with_capacity(function_name: String, capacity: usize) -> Self

Create a new ParametersSpec with the given function name and an advance capacity hint.

pub fn required(&mut self, name: &str)

Add a required parameter. Will be an error if the caller doesn’t supply it. If you want to supply a position-only argument, prepend a $ to the name.

pub fn optional(&mut self, name: &str)

Add an optional parameter. Will be None if the caller doesn’t supply it. If you want to supply a position-only argument, prepend a $ to the name.

pub fn defaulted(&mut self, name: &str, val: V)

Add an optional parameter. Will be the default value if the caller doesn’t supply it. If you want to supply a position-only argument, prepend a $ to the name.

pub fn args(&mut self)

Add an *args parameter which will be an iterable sequence of parameters, recorded into a Vec. A function can only have one args parameter. After this call, any subsequent required, optional or defaulted parameters can only be supplied by name.

pub fn no_args(&mut self)

This function has no *args parameter, corresponds to the Python parameter *. After this call, any subsequent required, optional or defaulted parameters can only be supplied by name.

pub fn kwargs(&mut self)

Add a **kwargs parameter which will be a dictionary, recorded into a SmallMap. A function can only have one kwargs parameter. parameter. After this call, any subsequent required, optional or defaulted parameters can only be supplied by position.

pub fn signature(&self) -> String

Produce an approximate signature for the function, combining the name and arguments.

impl<'v, V: ValueLike<'v>> ParametersSpec<V>

pub fn len(&self) -> usize

pub fn collect(
    &self,
    args: Arguments<'v, '_>,
    slots: &[Cell<Option<Value<'v>>>],
    heap: &'v Heap
) -> Result<()>

Move parameters from Arguments to a list of Value, using the supplied ParametersSpec.

pub fn collect_into<const N: usize>(
    &self,
    args: Arguments<'v, '_>,
    heap: &'v Heap
) -> Result<[Cell<Option<Value<'v>>>; N]>

pub fn documentation(
    &self,
    parameter_types: HashMap<usize, Type>,
    parameter_docs: HashMap<String, Option<DocString>>
) -> Vec<Param>

Generate documentation for each of the parameters.

Arguments

• parameter_types should be a mapping of parameter index to type
• parameter_docs should be a mapping of parameter name to possible documentation for that parameter

pub fn parser<R, F>(
    &self,
    args: Arguments<'v, '_>,
    eval: &mut Evaluator<'v, '_>,
    k: F
) -> Result<R> where
    F: FnOnce(ParametersParser<'v, '_>, &mut Evaluator<'v, '_>) -> Result<R>, 

Create a ParametersParser for given arguments.

impl<'v> ParametersSpec<Value<'v>>

pub fn freeze(self, freezer: &Freezer) -> Result<ParametersSpec<FrozenValue>>

Used to freeze a ParametersSpec.

Trait Implementations

impl<V: Clone> Clone for ParametersSpec<V>

fn clone(&self) -> ParametersSpec<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for ParametersSpec<V>

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

Formats the value using the given formatter.

impl<'v, V: Trace<'v>> Trace<'v> for ParametersSpec<V>

fn trace(&mut self, tracer: &Tracer<'v>)

impl<From: Coerce<To>, To> Coerce<ParametersSpec<To>> for ParametersSpec<From>