Enum Error 

#[non_exhaustive]
pub enum Error {
    UnexpectedArg {
        metadata: Metadata,
        raw_arg: String,
    },
    UndefinedCommand {
        metadata: Metadata,
        raw_arg: String,
    },
    MissingCommand {
        metadata: Metadata,
    },
    InvalidArg {
        arg: Box<Arg>,
        reason: String,
    },
    MissingArg {
        arg: Box<Arg>,
    },
    InvalidOpt {
        opt: Box<Opt>,
        reason: String,
    },
    MissingOpt {
        opt: Box<Opt>,
    },
    Other {
        metadata: Option<Metadata>,
        error: Box<dyn Display>,
    },
}

Possible errors.

Note that this enum is intended to be used only as a top-level error and deliberately does not implement the std::error::Error and std::fmt::Display traits.

Additionally, any external errors that implement std::fmt::Display can be converted into this error.

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.

UnexpectedArg

Fields

metadata: Metadata

raw_arg: String

UndefinedCommand

Fields

metadata: Metadata

raw_arg: String

MissingCommand

Fields

metadata: Metadata

InvalidArg

Fields

arg: Box<Arg>

reason: String

MissingArg

Fields

arg: Box<Arg>

InvalidOpt

Fields

opt: Box<Opt>

reason: String

MissingOpt

Fields

opt: Box<Opt>

Other

Fields

metadata: Option<Metadata>

error: Box<dyn Display>

Implementations

impl Error

pub fn other<E>(args: &RawArgs, error: E) -> Self

where E: 'static + Display,

Makes an application specific error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl<T: 'static + Display> From<T> for Error

fn from(error: T) -> Self

Converts to this type from the input type.