Enum Error

pub enum Error {
    DuplicateOption(String),
    MissingArgValue(String),
    MissingRequirements(MissingRequirements),
    OptionsAfterHelp,
    ParseArgument {
        arg: String,
        value: OsString,
        msg: String,
    },
    UnknownArgument(OsString),
    Other(String),
}

The error type for the argp parser.

Variants

DuplicateOption(String)

Duplicate value for a non-repeating option. The contained String is the option name (e.g. --foo).

MissingArgValue(String)

No value provided for the specified option.

MissingRequirements(MissingRequirements)

Missing required positional argument(s), option(s) or subcommand(s).

OptionsAfterHelp

Trailing options after the help subcommand.

ParseArgument

Error parsing the given value for the positional argument or option.

Fields

arg: String

The positional argument or option.

value: OsString

The given value that failed to be parsed.

msg: String

The error message from the value parser.

UnknownArgument(OsString)

Unknown argument.

Other(String)

Any other error.

Implementations

impl Error

pub fn other<S: ToString>(msg: S) -> Self

A convenient method for creating Error::Other.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for EarlyExit

fn from(value: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 StructuralPartialEq for Error