Enum ConfigError 

pub enum ConfigError {
    UnsupportedField {
        field: String,
        reason: String,
    },
    UnsupportedValue {
        field: String,
        reason: String,
    },
    MissingField {
        field: String,
    },
    EmptyField {
        field: String,
    },
    InvalidValue {
        field: String,
        reason: String,
    },
    InvalidFormat {
        field: String,
        expected: String,
    },
    Range {
        field: String,
        reason: String,
    },
    MutuallyExclusiveFields {
        fields: Vec<String>,
    },
    RequiredOneOf {
        fields: Vec<String>,
    },
    Dependency {
        field: String,
        depends_on: String,
        reason: String,
    },
    Duplicate {
        field: String,
        value: Option<String>,
    },
    FeatureDisabled {
        field: String,
        feature: String,
    },
    InvalidReference {
        field: String,
        reference: String,
        reason: String,
    },
    Multiple {
        errors: Vec<Self>,
    },
}

A typed configuration validation error with owned field paths.

Variants store owned field paths and explanatory text. Callers should avoid placing secrets in reason strings, reference names, or duplicate labels.

Variants

UnsupportedField

A field is not supported by the current runtime.

Fields

field: String

reason: String

UnsupportedValue

A field value is not supported by the current runtime.

Fields

field: String

reason: String

MissingField

A required field is missing.

Fields

field: String

EmptyField

A required field is present but empty.

Fields

field: String

InvalidValue

A field value is invalid.

Fields

field: String

reason: String

InvalidFormat

A field value has an invalid format.

Fields

field: String

expected: String

Range

A field value is outside the accepted range.

Fields

field: String

reason: String

MutuallyExclusiveFields

Fields were set together but are mutually exclusive.

Fields

fields: Vec<String>

RequiredOneOf

At least one of the listed fields is required.

Fields

fields: Vec<String>

Dependency

A field requires another field.

Fields

field: String

depends_on: String

reason: String

Duplicate

A field contains a duplicate entry.

Fields

field: String

value: Option<String>

FeatureDisabled

A field requires a disabled feature.

Fields

field: String

feature: String

InvalidReference

A field references an invalid object.

Fields

field: String

reference: String

reason: String

Multiple

Multiple config validation errors were collected.

Fields

errors: Vec<Self>

Implementations

impl ConfigError

pub fn unsupported_field( field: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates an unsupported-field error.

pub fn unsupported_value( field: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates an unsupported-value error.

pub fn missing_field(field: impl Into<String>) -> Self

Creates a missing-field error.

pub fn empty_field(field: impl Into<String>) -> Self

Creates an empty-field error.

pub fn invalid_value( field: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates an invalid-value error.

pub fn invalid_format( field: impl Into<String>, expected: impl Into<String>, ) -> Self

Creates an invalid-format error.

pub fn range(field: impl Into<String>, reason: impl Into<String>) -> Self

Creates a range error.

pub fn mutually_exclusive_fields( fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Creates a mutually-exclusive-fields error.

pub fn required_one_of( fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Creates a required-one-of error.

pub fn dependency( field: impl Into<String>, depends_on: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates a dependency error.

pub fn duplicate(field: impl Into<String>, value: Option<String>) -> Self

Creates a duplicate-entry error.

pub fn feature_disabled( field: impl Into<String>, feature: impl Into<String>, ) -> Self

Creates a feature-disabled error.

pub fn invalid_reference( field: impl Into<String>, reference: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates an invalid-reference error.

pub fn multiple(errors: Vec<Self>) -> Self

Creates a multiple-errors error.

Trait Implementations

impl Clone for ConfigError

fn clone(&self) -> ConfigError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

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