Struct ParseResult 

pub struct ParseResult { /* private fields */ }

Outcome of parsing a raw argv slice against a CommandSchema.

Holds typed-but-unconverted values; callers pull values out via ParseResult::flag, ParseResult::get, etc. Conversion happens lazily at extraction time so a single result can be probed with different target types during tests without repeated parsing.

Implementations

impl ParseResult

pub fn flag(&self, name: &str) -> bool

Check whether a boolean flag was provided.

pub fn get<T: FromArg>(&self, name: &str) -> Result<Option<T>>

Get the last value supplied for an option, converted via FromArg. Returns Ok(None) when the option is absent.

Looks up positional arguments as a fallback so callers don’t need two code paths for “option or argument by name”.

pub fn require<T: FromArg>(&self, name: &str) -> Result<T>

Like ParseResult::get but errors if the value is missing.

The error variant depends on the name shape: dash-prefixed names (e.g. --num, -n) become MissingOption, everything else becomes MissingArgument. That way a command that marks an option as required via require::<T>("--num") gets a diagnostic mentioning the option, not a positional argument.

pub fn all<T: FromArg>(&self, name: &str) -> Result<Vec<T>>

Get all values supplied for a repeatable option.

pub fn subcommand(&self) -> Option<(&str, &ParseResult)>

Return the matched subcommand name and its parse result, if any.

pub fn raw_value(&self, name: &str) -> Option<&str>

Raw access for advanced callers. Follows the same option/positional split as ParseResult::get: dash-prefixed names only look at option values; non-dash names look at options first, then positionals.

Trait Implementations

impl Debug for ParseResult

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

Formats the value using the given formatter.

impl Default for ParseResult

fn default() -> ParseResult

Returns the “default value” for a type.