Struct starlark::eval::ParametersSpecBuilder

pub struct ParametersSpecBuilder<V> { /* private fields */ }

Builder for ParametersSpec

Implementations

impl<V: Copy> ParametersSpecBuilder<V>

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_more_positional_only_args(&mut self)

Following parameters can be filled positionally or by name.

pub fn no_more_positional_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 finish(self) -> ParametersSpec<V>

Construct the parameters specification.