Enum lexopt::Error

pub enum Error {
    MissingValue {
        option: Option<String>,
    },
    UnexpectedOption(String),
    UnexpectedArgument(OsString),
    UnexpectedValue {
        option: String,
        value: OsString,
    },
    ParsingFailed {
        value: String,
        error: Box<dyn Error + Send + Sync + 'static>,
    },
    NonUnicodeValue(OsString),
    Custom(Box<dyn Error + Send + Sync + 'static>),
}

An error during argument parsing.

This implements From<String> and From<&str>, for easy ad-hoc error messages.

Variants

MissingValue

An option argument was expected but was not found.

Fields

option: Option<String>

The most recently emitted option.

UnexpectedOption(String)

An unexpected option was found.

UnexpectedArgument(OsString)

A positional argument was found when none was expected.

UnexpectedValue

An option had a value when none was expected.

Fields

option: String

The option.

value: OsString

The value.

ParsingFailed

Parsing a value failed. Returned by methods on ValueExt.

Fields

value: String

The string that failed to parse.

error: Box<dyn Error + Send + Sync + 'static>

The error returned while parsing.

NonUnicodeValue(OsString)

A value was found that was not valid unicode.

This can be returned by the methods on ValueExt.

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

For custom error messages in application code.

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<'a> From<&'a str> for Error

fn from(msg: &'a str) -> Self

Converts to this type from the input type.

impl From<OsString> for Error

For OsString::into_string, so it may be used with the try (?) operator.

ValueExt::string is the new preferred method because it’s compatible with catch-all error types like anyhow::Error.

fn from(arg: OsString) -> Self

Converts to this type from the input type.

impl From<String> for Error

fn from(msg: String) -> Self

Converts to this type from the input type.