Enum ConfigError 

pub enum ConfigError {
    Io(Error),
    Parse(Error),
    Validation(String),
    PathTraversal(String),
}

Errors that can occur when loading or saving configuration.

These errors are produced internally by Config::load and Config::save, as well as by any helper that reads or writes YAML state files.

For backward compatibility with existing callers that use anyhow, both functions still return anyhow::Result; ConfigError values are automatically coerced via the From impl that anyhow provides for any std::error::Error.

Example

use par_term_config::ConfigError;

fn check_load_err(e: &anyhow::Error) {
    if let Some(cfg_err) = e.downcast_ref::<ConfigError>() {
        match cfg_err {
            ConfigError::Io(io) => eprintln!("I/O error: {io}"),
            ConfigError::Parse(p) => eprintln!("YAML parse error: {p}"),
            ConfigError::Validation(msg) => eprintln!("Validation: {msg}"),
            ConfigError::PathTraversal(msg) => eprintln!("Path traversal: {msg}"),
        }
    }
}

Variants

Io(Error)

An I/O error occurred reading or writing the config file.

Parse(Error)

The config file contained invalid YAML that could not be parsed.

Validation(String)

A field value failed semantic validation.

The inner string describes which field is invalid and why.

PathTraversal(String)

A path resolved outside the expected configuration directory, indicating a potential directory traversal attempt.

The inner string includes the offending path and the expected base.

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, f: &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(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ConfigError

fn from(e: Error) -> Self

Converts to this type from the input type.