Enum ParseResult 

pub enum ParseResult {
    Exact {
        command: String,
        original: String,
        args: String,
    },
    AliasExpanded {
        command: String,
        original: String,
        args: String,
    },
    AutoCorrected {
        command: String,
        original: String,
        distance: usize,
        args: String,
    },
    Suggestions {
        original: String,
        suggestions: Vec<CommandSuggestion>,
    },
    Unknown {
        original: String,
    },
    Empty,
}

Result of parsing with the forgiving parser

Variants

Exact

Exact match found

Fields

command: String

The parsed command (canonical form)

original: String

Original input (same as command for exact match)

args: String

Remaining arguments after the command

AliasExpanded

Alias was expanded

Fields

command: String

The expanded canonical command

original: String

The original alias used

args: String

Remaining arguments

AutoCorrected

Command was auto-corrected due to typo

Fields

command: String

The corrected command

original: String

The original (misspelled) input

distance: usize

Edit distance

args: String

Remaining arguments

Suggestions

Multiple possible corrections - user should choose

Fields

original: String

Original input

suggestions: Vec<CommandSuggestion>

Possible corrections

Unknown

No match found

Fields

original: String

Original input

Empty

Empty input

Implementations

impl ParseResult

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

Get the command if parsing succeeded

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

Get the original input

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

Get the arguments if parsing succeeded

pub fn was_corrected(&self) -> bool

Check if this was auto-corrected

pub fn was_alias(&self) -> bool

Check if an alias was expanded

pub fn is_success(&self) -> bool

Check if parsing succeeded (command was determined)

pub fn full_command(&self) -> Option<String>

Get the full command line (command + args) for successful parses

Trait Implementations

impl Clone for ParseResult

fn clone(&self) -> ParseResult

Returns a duplicate 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.