Struct mica::Arguments

pub struct Arguments<'a> { /* private fields */ }

Arguments passed to a varargs function.

This is a wrapper that does things like type-checking and arity-checking.

Implementations

impl<'a> Arguments<'a>

pub fn new(raw_arguments: &'a [RawValue], env: &'a Environment) -> Self

Creates a new Arguments from a raw argument list, as is passed into a raw function.

pub fn count(&self) -> usize

Returns the number of arguments passed to the function.

pub fn expect_exactly(&self, n: usize) -> Result<(), Error>

Raises an error if there weren’t exactly n arguments passed to the function.

pub fn expect_at_least(&self, n: usize) -> Result<(), Error>

Raises an error if there weren’t at least n arguments passed to the function.

pub fn raw_self(&self) -> &RawValue

Returns the self parameter as a value.

pub fn nth(&self, n: usize) -> Option<&RawValue>

Returns the nth argument, or None if the argument is not present.

pub fn get<T>(&self, n: usize) -> Result<T, Error>where
    T: TryFromValue,

Returns the nth argument converted into the given type. Returns an error if there aren’t enough arguments.

pub fn array(&self) -> &[RawValue]

Returns the raw array of arguments.

Trait Implementations

impl<'a> Debug for Arguments<'a>

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

Formats the value using the given formatter.