Enum HoconError 

#[non_exhaustive]
pub enum HoconError {
    Parse(ParseError),
    Resolve(ResolveError),
    Io(Error),
    NotResolved(NotResolvedError),
    Config(ConfigError),
}

Unified error type returned by top-level parse functions.

Wraps the possible failure modes: syntax errors (ParseError), substitution resolution failures (ResolveError), file I/O errors (std::io::Error), unresolved-getter errors (NotResolvedError), and Config-boundary type errors (ConfigError — e.g. the S3.5 array-at-file-root rejection).

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.

Parse(ParseError)

Syntax error during lexing or parsing.

Resolve(ResolveError)

Substitution resolution failure (missing key, cycle, etc.).

Io(Error)

File I/O error when reading the top-level config file.

NotResolved(NotResolvedError)

A getter was called on a path whose value contains an unresolved substitution placeholder. Per E12 decision 12.

Config(ConfigError)

Type-mismatch error at the Config boundary (the Lightbend ConfigException.WrongType analog). Returned by the parse functions for an array-root document (S3.5, HOCON.md L989-991): the document is valid syntax, but the object-rooted Config API requires an object at file root. ConfigError.path is empty for file-root errors.

Trait Implementations

impl Debug for HoconError

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

Formats the value using the given formatter.

impl Display for HoconError

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

Formats the value using the given formatter.

impl Error for HoconError

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 HoconError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for HoconError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<ResolveError> for HoconError

fn from(e: ResolveError) -> Self

Converts to this type from the input type.