Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    Invalid {
        origin: String,
        key: String,
        text: String,
        expected: &'static str,
    },
    UnknownKey {
        origin: String,
        key: String,
        known: String,
    },
    File {
        path: String,
        message: String,
    },
}

Why a configuration could not be read.

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.

Invalid

A value that does not parse as its key’s type.

Fields

origin: String

The layer that gave it: command line, $VAR, or the file path.

key: String

The setting’s name.

text: String

The text given.

expected: &'static str

What the text may be (Value::EXPECTED).

UnknownKey

A setting name not in Config::KEYS.

Fields

origin: String

The layer that gave it.

key: String

The unknown name.

known: String

Every known name, comma-separated.

File

The config file could not be read or is not valid TOML.

Fields

path: String

The config file.

message: String

What went wrong.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

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.