Enum ConfigError 

pub enum ConfigError {
    Path(PathsError),
    Read {
        path: PathBuf,
        source: Error,
    },
    Parse {
        path: PathBuf,
        source: Error,
    },
    Write {
        path: PathBuf,
        source: Error,
    },
    Serialize(Error),
    UnsupportedSchemaVersion {
        path: PathBuf,
        found: u32,
    },
}

Failure loading or persisting config.toml. The file-scoped variants carry the offending path so callers can surface an actionable message.

Variants

Path(PathsError)

The platform config directory could not be resolved (no home directory for the current user).

Read

Reading the config file from disk failed.

Fields

path: PathBuf

The config file the read targeted.

source: Error

The underlying I/O error.

Parse

The file was read but is not valid TOML for this schema.

Fields

path: PathBuf

The config file that failed to parse.

source: Error

The underlying TOML deserialization error.

Write

Writing the updated config back to disk failed.

Fields

path: PathBuf

The config file the write targeted.

source: Error

The underlying I/O error.

Serialize(Error)

The in-memory config could not be serialized to TOML — a bug in the config types rather than user error, since Config always serializes cleanly.

UnsupportedSchemaVersion

The file declares a schema_version newer than this build understands; failing loudly avoids silently dropping settings a newer build wrote.

Fields

path: PathBuf

The config file carrying the unsupported version.

found: u32

The schema_version the file declared.

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<PathsError> for ConfigError

fn from(source: PathsError) -> Self

Converts to this type from the input type.