Struct ParseResult

pub struct ParseResult { /* private fields */ }

Represents the result of a parse operation and provides a set of methods to query over the values.

Implementations

impl ParseResult

pub fn new(command: Command, options: OptionList, args: ArgumentList) -> Self

Constructs a new ParseResult.

pub fn command_name(&self) -> &str

Returns the name of the executing command.

pub fn command_version(&self) -> Option<&str>

Returns the version of the executing command or None.

pub fn command_help(&self) -> Option<&str>

Returns the help message of the executing command or None.

pub fn command_usage(&self) -> Option<&str>

Returns the usage message of the executing command or None.

pub fn options(&self) -> &OptionList

Returns the Options passed to the executing command.

pub fn arg(&self) -> Option<&Argument>

Returns the Argument passed to the executing command or None is there is more than 1 argument.

pub fn args(&self) -> &ArgumentList

Returns the Arguments passed to the executing command.

pub fn value_of(&self, arg_name: &str) -> Option<&str>

Gets the value of the argument with the given name.

pub fn values_of(&self, arg_name: &str) -> Option<Values<'_>>

Gets an iterator over the values of the argument with the given name.

pub fn value_of_option(&self, option_name: &str) -> Option<&str>

Gets the value of the argument of the given option.

pub fn values_of_option(&self, option_name: &str) -> Option<Values<'_>>

Gets an iterator over the values of the arguments of the given option.

pub fn value_of_as<T>(&self, arg_name: &str) -> Option<T>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Gets the value of the argument with the given name as a type T.

pub fn values_of_as<T>(&self, arg_name: &str) -> Option<Vec<T>>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Gets the values of the argument as a Vec<T>.

pub fn value_of_option_as<T>(&self, option_name: &str) -> Option<T>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Gets the value of the argument of the given option as a type T.

pub fn values_of_option_as<T>(&self, option_name: &str) -> Option<Vec<T>>

where T: FromStr + 'static, <T as FromStr>::Err: Display,

Gets the values of the given option as a type T.

Trait Implementations

impl Clone for ParseResult

fn clone(&self) -> ParseResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseResult

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

Formats the value using the given formatter.