Enum ConfigError 

pub enum ConfigError {
    PropertyNotFound(String),
    PropertyHasNoValue(String),
    TypeMismatch {
        key: String,
        expected: DataType,
        actual: DataType,
    },
    ConversionError {
        key: String,
        message: String,
    },
    IndexOutOfBounds {
        index: usize,
        len: usize,
    },
    SubstitutionError(String),
    SubstitutionDepthExceeded(usize),
    SubstitutionCycle {
        chain: Vec<String>,
    },
    MergeError(String),
    PropertyIsFinal(String),
    KeyConflict {
        path: String,
        existing: String,
        incoming: String,
    },
    IoError(Error),
    ParseError(String),
    DeserializeError {
        path: String,
        message: String,
        source: Option<Box<ConfigError>>,
    },
    Other(String),
}

Configuration error type

Defines all possible error scenarios in the configuration system.

Examples

use qubit_config::{Config, ConfigError, ConfigResult};
fn get_port(config: &Config) -> ConfigResult<i32> { unimplemented!() }

Variants

PropertyNotFound(String)

Property not found

PropertyHasNoValue(String)

Property has no value

TypeMismatch

Type mismatch at a specific key/path

Fields

key: String

The configuration key/path where the mismatch occurred

expected: DataType

Expected type

actual: DataType

Actual type

ConversionError

Type conversion failed at a specific key/path

Fields

key: String

The configuration key/path where the conversion failed

message: String

Error message

IndexOutOfBounds

Index out of bounds

Fields

index: usize

Index being accessed

len: usize

Actual length

SubstitutionError(String)

Variable substitution failed

SubstitutionDepthExceeded(usize)

Variable substitution depth exceeded

SubstitutionCycle

Variable substitution cycle detected

Fields

chain: Vec<String>

Variable chain that forms the cycle

MergeError(String)

Configuration merge failed

PropertyIsFinal(String)

Property is final and cannot be overridden

KeyConflict

Configuration key path cannot be represented without ambiguity

Fields

path: String

The conflicting configuration key/path

existing: String

Existing value or path shape

incoming: String

Incoming value or path shape

IoError(Error)

IO error

ParseError(String)

Parse error

DeserializeError

Deserialization error for structured config mapping

Fields

path: String

The config prefix/path being deserialized

message: String

Error message

source: Option<Box<ConfigError>>

Original structured error when it came from config parsing

Other(String)

Other error

Implementations

impl ConfigError

pub fn from_data_conversion_error(key: &str, err: DataConversionError) -> Self

Maps a common data conversion error to a keyed configuration error.

Parameters

• key - Configuration key that was being parsed.
• err - Error returned by the common conversion layer.

Returns

A ConfigError carrying the supplied key.

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.

impl From<(&str, ValueError)> for ConfigError

fn from((key, err): (&str, ValueError)) -> Self

Converts to this type from the input type.

impl From<Error> for ConfigError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ValueError> for ConfigError

fn from(err: ValueError) -> Self

Converts to this type from the input type.