Struct ParametersSpec

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

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_parts<'a>( function_name: &str, pos_only: impl IntoIterator<Item = (&'a str, ParametersSpecParam<V>)>, pos_or_named: impl IntoIterator<Item = (&'a str, ParametersSpecParam<V>)>, args: bool, named_only: impl IntoIterator<Item = (&'a str, ParametersSpecParam<V>)>, kwargs: bool, ) -> ParametersSpec<V>

where V: Copy,

Create a new ParametersSpec.

pub fn new_named_only<'a>( function_name: &str, named_only: impl IntoIterator<Item = (&'a str, ParametersSpecParam<V>)>, ) -> ParametersSpec<V>

where V: Copy,

Parameter parse with only named parameters.

pub fn signature(&self) -> String

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

pub fn parameters_str(&self) -> String

Function parameter as they would appear in def (excluding types, default values and formatting).

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

pub fn len(&self) -> usize

Number of function parameters.

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

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

Collect N arguments.

This function is called by generated code.

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

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

pub fn documentation( &self, parameter_types: Vec<Ty>, parameter_docs: HashMap<String, Option<DocString>>, ) -> DocParams

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(&mut ParametersParser<'v, '_>, &mut Evaluator<'v, '_, '_>) -> Result<R>,

Create a ParametersParser for given arguments.

pub fn can_fill_with_args(&self, pos: usize, names: &[&str]) -> bool

Check if current parameters can be filled with given arguments signature.

Trait Implementations

impl<V: Allocative> Allocative for ParametersSpec<V>

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

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

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

Returns a duplicate 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: Freeze> Freeze for ParametersSpec<V>

type Frozen = ParametersSpec<<V as Freeze>::Frozen>

When type is frozen, it is frozen into this type.

fn freeze(self, freezer: &Freezer) -> FreezeResult<Self::Frozen>

Freeze a value. The frozen value must be equal to the original, and produce the same hash.

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

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

Recursively “trace” the value.