Enum ConfigError 

pub enum ConfigError {
    Read {
        path: PathBuf,
        message: String,
    },
    Syntax {
        path: PathBuf,
        message: String,
    },
    Setting {
        key: String,
        message: String,
        next: String,
    },
}

A configuration this product will not run on.

Every variant names the thing a user has to go and change and says what to change it to. That is the whole point: an unknown field, a bad value, an unknown plugin name and an unusable source name are all usage errors here, never settings that get quietly dropped.

Variants

Read

A configuration document exists but could not be read.

Fields

path: PathBuf

The document that could not be read.

message: String

What the filesystem said.

Syntax

A configuration document is not valid YAML.

Fields

path: PathBuf

The document that would not parse.

message: String

What the parser said, position included.

Setting

One setting is unknown, or its value is not usable.

key is the dotted path a user can search their configuration for and is also the path the environment-variable and --set spellings are derived from, so one name locates the problem at whichever layer set it.

Fields

key: String

The dotted path of the offending setting.

message: String

What is wrong with it.

next: String

The concrete next action.

Implementations

impl ConfigError

pub fn key(&self) -> Option<&str>

The dotted key this error names, when it names one.

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, __formatter: &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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConfigError