Enum Error 

pub enum Error {
    User(String),
    UserAny(Box<dyn Error + Send + Sync + 'static>),
    Parse(String),
    ExitMsg {
        code: i32,
        message: Option<String>,
    },
    UnknownOption {
        token: String,
        suggestions: Vec<String>,
    },
    UnknownCommand {
        token: String,
        suggestions: Vec<String>,
    },
    MissingValue {
        opt: String,
    },
    UnexpectedPositional {
        token: String,
    },
}

Top-level error type.

Variants

User(String)

Invalid CLI input (unknown flag, bad value, missing value, etc.).

UserAny(Box<dyn Error + Send + Sync + 'static>)

Arbitrary user error bubbled from callbacks.

Parse(String)

Internal/structural error (should be rare).

ExitMsg

Exit with a specific code (e.g., --help). Optional message payload.

Fields

code: i32

message: Option<String>

UnknownOption

Rich diagnostics

Fields

token: String

suggestions: Vec<String>

UnknownCommand

Fields

token: String

suggestions: Vec<String>

MissingValue

Fields

opt: String

UnexpectedPositional

Fields

token: String

Implementations

impl Error

pub fn user<E>(e: E) -> Self

where E: Error + Send + Sync + 'static,

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<Box<dyn Error + Sync + Send>> for Error

fn from(e: Box<dyn Error + Send + Sync + 'static>) -> Self

Converts to this type from the input type.