Args

Struct Args 

Source
pub struct Args { /* private fields */ }
Expand description

Arguments for function calls with fluent API for easy consumption

Implementations§

Source§

impl Args

Source

pub fn new(positional: Vec<Value>, keywords: IndexMap<String, Value>) -> Self

Source

pub fn positional(positional: Vec<Value>) -> Self

Source

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

Set the function name for error messages

Source

pub fn expect(&mut self, name: &str) -> Result<Value>

Get the next positional argument with a descriptive name

Source

pub fn optional(&mut self, _name: &str, default: Value) -> Value

Get an optional positional argument with a default value

Source

pub fn keyword(&mut self, name: &str) -> Result<Value>

Get a keyword argument by name

Source

pub fn keyword_optional(&mut self, name: &str, default: Value) -> Value

Get an optional keyword argument with a default value

Source

pub fn rest(&mut self) -> Vec<Value>

Consume all remaining positional arguments

Source

pub fn complete(&self) -> Result<()>

Check that all arguments have been consumed

Source

pub fn len(&self) -> usize

Get the total number of arguments provided

Source

pub fn is_empty(&self) -> bool

Check if no arguments were provided

Source§

impl Args

Helper functions for common Args patterns in RustValue implementations

Source

pub fn no_args(&mut self, function_name: &str) -> Result<()>

Handle no-argument methods - sets function name and validates no args

Source

pub fn single_f64(&mut self, function_name: &str, arg_name: &str) -> Result<f64>

Handle single f64 argument methods

Source

pub fn single_i64(&mut self, function_name: &str, arg_name: &str) -> Result<i64>

Handle single i64 argument methods

Source

pub fn single_bool( &mut self, function_name: &str, arg_name: &str, ) -> Result<bool>

Handle single bool argument methods

Source

pub fn single_string( &mut self, function_name: &str, arg_name: &str, ) -> Result<String>

Handle single string argument methods

Source

pub fn single_rust_value<T: RustValue + 'static>( &mut self, function_name: &str, arg_name: &str, expected_type: &str, ) -> Result<Value>

Handle single RustValue argument methods with type checking

Source

pub fn two_f64( &mut self, function_name: &str, arg1_name: &str, arg2_name: &str, ) -> Result<(f64, f64)>

Handle two f64 argument methods

Trait Implementations§

Source§

impl Clone for Args

Source§

fn clone(&self) -> Args

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Args

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Vec<Value>> for Args

Source§

fn from(positional: Vec<Value>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Args

§

impl !RefUnwindSafe for Args

§

impl !Send for Args

§

impl !Sync for Args

§

impl Unpin for Args

§

impl !UnwindSafe for Args

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.