Enum BuilderError 

pub enum BuilderError {
    Io {
        path: PathBuf,
        error: Error,
    },
    Parse {
        path: Option<PathBuf>,
        source: String,
        error: Error,
    },
    Deserialize {
        path: Option<PathBuf>,
        source: String,
        error: FromTomlError,
    },
    Merge(BuilderMergeError),
}

Represents an error encountered while building a configuration.

Variants

Io

Failed to read the provided configuration file.

Fields

path: PathBuf

The path to the file.

error: Error

The error that was encountered.

Parse

Failed to parse the provided configuration file.

Fields

path: Option<PathBuf>

The path to the file.

This is None when the source was a string.

source: String

The TOML source that was parsed.

error: Error

The error that was encountered.

Deserialize

Failed to deserialize the provided configuration file.

Fields

path: Option<PathBuf>

The path to the file.

This is None when the source was a string.

source: String

The TOML source that was parsed.

error: FromTomlError

The error that was encountered.

Merge(BuilderMergeError)

Failed to merge configuration.

Implementations

impl BuilderError

pub fn path(&self) -> impl Display + Clone

Gets the path associated with the error.

If the error relates to parsing or deserializing an in-memory string, the path will be <string>.

If the error relates to parsing or deserializing the merged configuration, the path will be <merged>.

pub fn toml_error(&self) -> Option<&Error>

Gets the TOML error associated with the error.

Returns None if the error is not associated with parsing or deserializing TOML.

pub fn source(&self) -> Option<&str>

Gets the TOML source code associated with the error.

Returns None if the error is not associated with parsing or deserializing TOML.

pub fn to_diagnostic(&self) -> Diagnostic

Converts the error into a Diagnostic.

Trait Implementations

impl Debug for BuilderError

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

Formats the value using the given formatter.

impl Display for BuilderError

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

Formats the value using the given formatter.

impl Error for BuilderError

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<BuilderMergeError> for BuilderError

fn from(source: BuilderMergeError) -> Self

Converts to this type from the input type.