Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    FileNotFound(PathBuf),
    FileIo {
        path: PathBuf,
        message: String,
        source: Error,
    },
    FileParse {
        path: PathBuf,
        message: String,
        source: Box<Error>,
    },
}

All errors that may occur while loading a voxora configuration.

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.

FileNotFound(PathBuf)

The requested config file does not exist. Callers that treat a missing file as “just use the defaults” should match on this variant instead of ignoring every error.

FileIo

The config file exists but could not be read.

Fields

path: PathBuf

Path that failed to read.

message: String

Human-readable description of the failing operation.

source: Error

Underlying error.

FileParse

The config file was read but is not valid TOML, or contains a key that does not belong to the schema.

The parser error is boxed: toml::de::Error alone is larger than the whole rest of this enum, and every Result in the crate would pay for it.

Fields

path: PathBuf

Path that failed to parse ("inline" for string input).

message: String

Human-readable description from the TOML parser.

source: Box<Error>

Underlying error.

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.