Struct Args 

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

The list of arguments passed to a command

This list excludes Flags, and separates arguments either by whitespace, or by non escaped double quotes.

//                    cmd │      flags      │         arguments
//                   ┌   ┐│┌               ┐│┌  ┐ ┌        ┐ ┌   ┐ ┌   ┐
cmd::queue_notify(r#"mycmd --flags -moreflag arg1 "more arg" \"arg arg\""#);

Implementations

impl<'a> Args<'a>

pub fn next(&mut self) -> Result<&'a str, Text>

Returns the next word or quoted argument

pub fn next_as<P: Parameter<'a>>( &mut self, pa: &Pass, ) -> Result<P::Returns, Text>

Tries to parse the next argument as P

If parsing fails, Args will be reset as if this function wasn’t called.

pub fn next_as_with_form<P: Parameter<'a>>( &mut self, pa: &Pass, ) -> Result<(P::Returns, Option<FormId>), Text>

Tries to parse the next argument as P

If parsing fails, Args will be reset as if this function wasn’t called.

pub fn next_else<T: Into<Text>>(&mut self, to_text: T) -> Result<&'a str, Text>

Tries to get the next argument, otherwise returns a Text

pub fn next_start(&mut self) -> Option<usize>

Returns the char position of the next argument

Mostly used for error feedback by the PromptLine

pub fn param_range(&self) -> Range<usize>

The range of the previous Parameter

Mostly used for error feedback by the PromptLine