Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    Frozen,
    NotFound(String),
    PathParse {
        cause: Box<dyn Error + Send + Sync>,
    },
    FileParse {
        uri: Option<String>,
        cause: Box<dyn Error + Send + Sync>,
    },
    Type {
        origin: Option<String>,
        unexpected: Unexpected,
        expected: &'static str,
        key: Option<String>,
    },
    At {
        error: Box<ConfigError>,
        origin: Option<String>,
        key: Option<String>,
    },
    Message(String),
    Foreign(Box<dyn Error + Send + Sync>),
}

Represents all possible errors that can occur when working with configuration.

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.

Frozen

Configuration is frozen and no further mutations can be made.

NotFound(String)

Configuration property was not found

PathParse

Configuration path could not be parsed.

Fields

cause: Box<dyn Error + Send + Sync>

FileParse

Configuration could not be parsed from file.

Fields

uri: Option<String>

The URI used to access the file (if not loaded from a string). Example: /path/to/config.json

cause: Box<dyn Error + Send + Sync>

The captured error from attempting to parse the file in its desired format. This is the actual error object from the library used for the parsing.

Type

Value could not be converted into the requested type.

Fields

origin: Option<String>

The URI that references the source that the value came from. Example: /path/to/config.json or Environment or etcd://localhost

unexpected: Unexpected

What we found when parsing the value

expected: &'static str

What was expected when parsing the value

key: Option<String>

The key in the configuration hash of this value (if available where the error is generated).

At

Custom message

Fields

error: Box<ConfigError>

Error being extended with a path

origin: Option<String>

The URI that references the source that the value came from. Example: /path/to/config.json or Environment or etcd://localhost

key: Option<String>

The key in the configuration hash of this value (if available where the error is generated).

Message(String)

Custom message

Foreign(Box<dyn Error + Send + Sync>)

Unadorned error from a foreign origin.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

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 Error for ConfigError

fn custom<T>(msg: T) -> ConfigError

where T: Display,

Raised when there is general error when deserializing a type.

fn missing_field(field: &'static str) -> ConfigError

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl Error for ConfigError

fn custom<T>(msg: T) -> ConfigError

where T: Display,

Used when a Serialize implementation encounters any error while serializing a type.