Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    ParseError {
        field: String,
        raw_display: String,
        expected_type: String,
        source: Box<dyn Error + Send + Sync>,
    },
    FileError {
        path: PathBuf,
        source: Box<dyn Error + Send + Sync>,
    },
    EnvVar {
        key: String,
        cause: String,
    },
    FieldConflict {
        field: String,
        a: Source,
        b: Source,
    },
    MissingRequired {
        field: String,
    },
    Internal {
        message: String,
    },
}

All errors that cistell-core can produce.

#[non_exhaustive] so we can add variants in minor versions without breaking downstream match arms.

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.

ParseError

A value could not be parsed into the expected type.

Fields

field: String

raw_display: String

The raw value (or "<secret>" if the field is secret).

expected_type: String

source: Box<dyn Error + Send + Sync>

FileError

A config file could not be read or parsed.

Fields

path: PathBuf

source: Box<dyn Error + Send + Sync>

EnvVar

An environment variable exists but is not valid UTF-8.

Fields

key: String

cause: String

FieldConflict

Two sources at the same rank provide conflicting values.

Fields

field: String

a: Source

b: Source

MissingRequired

A required field has no default and no source provided a value.

Fields

field: String

Internal

An internal invariant was violated (should never happen in normal operation).

Fields

message: String

Implementations

impl ConfigError

pub fn parse<E>(meta: &FieldMeta, raw: &str, source: E) -> Self

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

Create a ParseError, automatically redacting the raw value when meta.is_secret.

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, f: &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.