Struct argparsnip::Results

pub struct Results<'a> {
    pub path: &'a str,
    pub flags: HashMap<&'a str, i32>,
    pub params: HashMap<&'a str, Value>,
    pub unknown_params: Vec<String>,
    pub positional: Vec<String>,
}

Results object returned by arg parsing (or passed to the handler)

Fields

path: &'a str

the Args struct we matched’s path, used to uniquely identify the command/subcommand

flags: HashMap<&'a str, i32>

mapping of flags to the number of times they were seen

params: HashMap<&'a str, Value>

mapping of args to the values seen for them if it is specified that the arg should only match one time this will be a single Value, otherwise it will be a Value::Array

unknown_params: Vec<String>

list of params seen that were not recognised @todo: support failing if this isn’t empty

positional: Vec<String>

list of positional arguments seen note that while in the current implementation these can be interspersed between args, e.g –flag positional –flag2 is considered valid we do not guarantee that this will be true in future versions

Trait Implementations

impl<'a> Debug for Results<'a>

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

Formats the value using the given formatter.

impl<'a> Handler<'a, Results<'a>> for Results<'a>

fn handler() -> fn(_: Results<'a>) -> Self

impl<'a> PartialEq<Results<'a>> for Results<'a>

fn eq(&self, other: &Results<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Results<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Results<'a>