Struct cuicui_chirp::parse_dsl::args::Arguments

pub struct Arguments<'i, 'a>(/* private fields */);

Arguments passed to a method.

In the chirp file, this corresponds to the text within parenthesis following a method name:

//                 vvvv  vvvvvvvvv     vvvvvv
Entity(method_name(arg1, arg2(Foo)   , 10 + 3) other_method))

Arguments will be stripped of comments and surrouding spaces, and parameter substitution will be applied within templates.

Call format

You can use Arguments::len to check how many arguments were passed to the method and Arguments::get to access an argument at a provided index.

A bare method (without following parenthesis) will have zero arguments, a method with following parenthesis with no arguments will also have zero arguments.

For example:

Entity(bare_method method1() method2(foobar) method3("foobar") method4(  10 + 3 , bar))

name	bare_method	method1	method2	method3	method4
ctx.arguments.get(0)	None	None	foobar	"foobar"	10 + 3
ctx.arguments.len()	0	0	1	1	2

How to handle argument parsing

cuicui_chirp expects end-users to use the parse_dsl_impl macro or ReflectDsl struct to take care of parsing for them.

A set of “blessed” parsers is predefined in the args module. Those are the parsers used by default by parse_dsl_impl.

You can call them with the output of Arguments::get_str.

ReflectDsl uses the from_reflect and to_handle parsers.

Implementations

impl<'i, 'a> Arguments<'i, 'a>

pub const fn is_empty(&self) -> bool

Whether arguments were passed to the method.

pub const fn len(&self) -> usize

How many arguments were passed to the method.

pub fn get(&self, index: usize) -> Option<Cow<'_, [u8]>>

Get the indexth argument passed to the method.

None if index > self.len().

Template parameter substitution is applied. This allocates if there is one or more substitutions for the queryed argument, that is not the whole argument.

Note that trailing and leading whitespaces are trimmed from arguments.

pub fn get_str(&self, index: usize) -> Option<Cow<'_, str>>

Get the indexth argument passed to the method as a str.

See Self::get for more details.

May allocate on invalid UTF8 (uses String::from_utf8_lossy internally).

Panics

Will panics on invalid UTF8, if the argument was substitued.