Enum Error

pub enum Error {
    Io {
        message: String,
    },
    File {
        path: String,
    },
    Parse,
    Include {
        path: String,
    },
    TooManyIncludes,
    IncludeNotAllowedFromStr,
    DisabledExternalUrl,
    KeyNotFound {
        key: String,
    },
    MissingKey,
    InvalidKey,
    Deserialization {
        message: String,
    },
}

Errors that can be encountered while reading a HOCON document

Variants

Io

Captures IO-Errors. Usually we would use a transparent error but io::Error is not clonable

Fields

message: String

the description of the original IOError

File

Error reading a file. This can be a file not found, a permission issue, …

Fields

path: String

Path to the file being read

Parse

Error while parsing a document. The document is not valid HOCON

Include

Error including a document

Fields

path: String

Path of the included file

TooManyIncludes

Error processing deep includes. You can change the maximum depth using max_include_depth

IncludeNotAllowedFromStr

Error processing includes from a str source. This is not allowed

DisabledExternalUrl

Error including document with External URL as feature has been disabled

KeyNotFound

Error looking for a key

Fields

key: String

Key that was searched

MissingKey

Error getting a value because key is not present

InvalidKey

Error getting a value because of an invalid key type

Deserialization

Error deserializing

Fields

message: String

Error message returned from deserialization

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

this is only needed because this crate heavily relies on Clone and io:Error doesnt implement Clone

fn from(e: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error