Enum ClapfigError 

pub enum ClapfigError {
    UnknownKeys(Vec<UnknownKeyInfo>),
    ParseError {
        path: PathBuf,
        source: Box<Error>,
        source_text: Option<Arc<str>>,
    },
    IoError {
        path: PathBuf,
        source: Error,
    },
    ConfigError(Error),
    KeyNotFound(String),
    InvalidValue {
        key: String,
        reason: String,
    },
    NoPersistPath,
    AncestorsNotAllowedAsPersistPath,
    UnknownScope {
        scope: String,
        available: Vec<String>,
    },
    UnknownSubcommand(String),
    AppNameRequired,
    PostValidationFailed(String),
}

Variants

UnknownKeys(Vec<UnknownKeyInfo>)

One or more unknown keys were found in config files during strict-mode validation. The vector is never empty.

ParseError

The TOML parser failed on a config file. source_text holds the file contents (when retained) so renderers can draw a snippet. The parser error is boxed to keep the enum variant small.

Fields

path: PathBuf

source: Box<Error>

source_text: Option<Arc<str>>

IoError

Fields

path: PathBuf

source: Error

ConfigError(Error)

KeyNotFound(String)

InvalidValue

Fields

key: String

reason: String

NoPersistPath

AncestorsNotAllowedAsPersistPath

UnknownScope

Fields

scope: String

available: Vec<String>

UnknownSubcommand(String)

AppNameRequired

PostValidationFailed(String)

A user-supplied post_validate hook rejected the merged configuration.

The inner string is the message returned by the hook — typically something like "port 80 is below the allowed minimum 1024". Clapfig does not interpret it; the displayed/rendered form includes the "Configuration validation failed: " prefix plus the hook’s message.

Implementations

impl ClapfigError

pub fn unknown_keys(&self) -> Option<&[UnknownKeyInfo]>

If this error carries unknown-key information, return the list.

Callers that want to render their own error UI can iterate this directly without pattern-matching on the enum.

pub fn parse_error(&self) -> Option<(&Path, &Error, Option<&str>)>

If this error is a TOML parse failure, return the file path, the underlying parser error, and the source text (when retained).

pub fn is_strict_violation(&self) -> bool

True if this error represents a strict-mode schema violation (unknown keys) — useful for callers that want to fail softly on strict violations but hard on real parse/type errors.

Trait Implementations

impl Debug for ClapfigError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ClapfigError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ClapfigError

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 ClapfigError

fn from(source: Error) -> Self

Converts to this type from the input type.