Enum InvalidOption

pub enum InvalidOption {
    OptionContainsInvalidChar {
        option: String,
    },
    UnconfiguredOption {
        option: String,
    },
    OptionNeedsArg {
        option: String,
        store_key: String,
    },
    OptionTakesNoArg {
        option: String,
        store_key: String,
    },
    OptionIsNotArray {
        option: String,
        store_key: String,
    },
    StoreKeyIsDuplicated {
        store_key: String,
        name: String,
    },
    ConfigIsArrayButHasNoArg {
        store_key: String,
        name: String,
    },
    ConfigHasDefaultsButHasNoArg {
        store_key: String,
        name: String,
    },
    OptionNameIsDuplicated {
        store_key: String,
        name: String,
    },
    OptionArgIsInvalid {
        store_key: String,
        option: String,
        opt_arg: String,
        details: String,
    },
}

The enum type for errors of options or option arguments.

This enum type has option() method, which makes it possible to handle option-related errors in a unified manner.

Variants

OptionContainsInvalidChar

Indicates that the name of an option is using invalid characters. This error occurs if the name contains symbols or starts with a symbol or number.

Fields

option: String

The option name that caused this error.

UnconfiguredOption

Indicates that the option with the specified name does not exist in the option configurations.

Fields

option: String

The option name that caused this error.

OptionNeedsArg

Indicates that the option requires arguments in the configuration, but no argument is specified.

Fields

option: String

The option name that caused this error.

store_key: String

The store key of the specified option in the configuration.

OptionTakesNoArg

Indicates that the option is not suppoesed to take an argument in the configuration, but an argument is specified.

Fields

option: String

The option name that caused this error.

store_key: String

The store key of the specified option in the configuration.

OptionIsNotArray

Indicates that the option is supposed to take one argument in the configuration, but multiple arguments are specified.

Fields

option: String

The option name that caused this error.

store_key: String

The store key of the specified option in the configuration.

StoreKeyIsDuplicated

Indicates that there are duplicated store keys among multiple configurations.

Fields

store_key: String

The store key that caused this error.

name: String

The first name of the option configuration.

ConfigIsArrayButHasNoArg

Indicates that an option configuration contradicts that the option can take multiple arguments (.is_array == true) though it does not take option arguments (.has_arg == false).

Fields

store_key: String

The store key of the option configuration that caused this error.

name: String

The first name of the option configuration.

ConfigHasDefaultsButHasNoArg

Indicates that an option configuration contradicts that the default arguments (.defaults) is not empty though it does not take option arguments (.has_arg == false).

Fields

store_key: String

The store key of the option configuration that caused this error.

name: String

The first name of the option configuration.

OptionNameIsDuplicated

Indicates that there are duplicated opton names among the option configurations.

Fields

store_key: String

The store key of the option configuration that caused this error.

name: String

The duplicated name of the option configuration.

OptionArgIsInvalid

Indicates that the option argument is invalidated by the validator in the option configuration.

Fields

store_key: String

The store key of the option configuration that caused this error.

option: String

The option name that caused this error.

opt_arg: String

The option argument that was validated.

details: String

The details for the invalidation.

Implementations

impl InvalidOption

pub fn option(&self) -> &str

Returns the name of the option that caused the error.

Trait Implementations

impl Debug for InvalidOption

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

Formats the value using the given formatter.

impl Display for InvalidOption

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

Formats the value using the given formatter.

impl Error for InvalidOption

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 PartialEq for InvalidOption

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