Enum ParseError 

#[non_exhaustive]
pub enum ParseError<'a> {
    UnknownShortOption(char, Field),
    UnknownLongOption(Field),
    UnsupportedLongOption(Field, &'a OptionSpec<'a>),
    AmbiguousLongOption(Field, Vec<&'a OptionSpec<'a>>),
    MissingOptionArgument(Field, &'a OptionSpec<'a>),
    UnexpectedOptionArgument(Field, &'a OptionSpec<'a>),
}

Error in command line parsing

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownShortOption(char, Field)

Short option that is not defined in the option specs

UnknownLongOption(Field)

Long option that is not defined in the option specs

UnsupportedLongOption(Field, &'a OptionSpec<'a>)

Long option that is defined in an option spec but disabled by configuration (Mode).

AmbiguousLongOption(Field, Vec<&'a OptionSpec<'a>>)

Long option that matches more than one option spec

The second item of the tuple is a list of all option specs that matched.

MissingOptionArgument(Field, &'a OptionSpec<'a>)

Option missing its required argument

UnexpectedOptionArgument(Field, &'a OptionSpec<'a>)

Long option having an unexpected argument

Implementations

impl ParseError<'_>

pub fn field(&self) -> &Field

Returns a reference to the field in which the error occurred.

pub fn to_report(&self) -> Report<'_>

Converts this error to a Report.

Trait Implementations

impl<'a> Clone for ParseError<'a>

fn clone(&self) -> ParseError<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParseError<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ParseError<'a>

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

Formats the value using the given formatter.

impl<'a> Error for ParseError<'a>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<'a> From<&'a ParseError<'a>> for Report<'a>

fn from(error: &'a ParseError<'a>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl From<ParseError<'static>> for Error

fn from(source: ParseError<'static>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for ParseError<'a>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ParseError<'a>

impl<'a> StructuralPartialEq for ParseError<'a>