Enum clargs::ParsingError

pub enum ParsingError {
    Unrecognized(String),
    Ambiguous(String, Vec<String>),
    MissingArgument(String),
    ArgumentParsingError(String, String),
    ParameterRepetition(String),
}

Returned when an error occurs during parsing.

Indicates the type of error that occurred and contains some extra data about the error.

Variants

Unrecognized(String)

Indicates an unknown option was passed to the parser. The associated string is set to the affected option's name.

Ambiguous(String, Vec<String>)

Indicates an argument could be multiple valid options. The associated string is set to the affected argument. The associated vector of strings is set to the valid options that the argument could have been.

MissingArgument(String)

Indicates a named parameter is missing an argument. The associated string is set to the affected parameter's name.

ArgumentParsingError(String, String)

Indicates a named parameter's argument could not be parsed into the parameter's associated type. The first associated string is set to the affected parameter's name. The second associated string is set to the affected parameter's argument.

ParameterRepetition(String)

Indicates a named parameter was set multiple times. The associated string is set to the affected parameter's name.

Methods

impl ParsingError

fn default_message(&self) -> String

Returns a default error message for the specified ParsingError.

Trait Implementations

impl Debug for ParsingError

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for ParsingError

fn eq(&self, __arg_0: &ParsingError) -> bool

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

fn ne(&self, __arg_0: &ParsingError) -> bool

This method tests for !=.

impl Eq for ParsingError

impl PartialOrd for ParsingError

fn partial_cmp(&self, __arg_0: &ParsingError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &ParsingError) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &ParsingError) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &ParsingError) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &ParsingError) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for ParsingError

fn cmp(&self, __arg_0: &ParsingError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.