Struct miau::error::ConfigurationError

pub struct ConfigurationError { /* fields omitted */ }

Represents all errors that might occur at all stages of processing configuration.

Implementations

impl ConfigurationError

pub fn inner(&self) -> &ErrorCode

Returns reference to underlying error code. Returned object has all contextual information stripped off.

pub fn enrich_with_context<T: Display>(self, message: T) -> Self

Enriches error context with arbitray message.

Used to put more contextual information in the error to facilitate debugging issues. One can put e.g. path to file that failed to open in error message this way.

Example

use miau::error::{ConfigurationError, ErrorCode};

let error: ConfigurationError = ErrorCode::NullValue.into();

let enriched_error = error
    .enrich_with_context("Detailed description of contextual information");

pub fn enrich_with_key(self, key: Key) -> Self

Enriches error context with a key.

Used to put more contextual information in the error to facilitate debugging issues. One can put information about location in configuration tree in error with this function.

Example

use miau::error::{ConfigurationError, ErrorCode};
use miau::configuration::Key;

let error: ConfigurationError = ErrorCode::NullValue.into();

let enriched_error = error
    .enrich_with_key(Key::Map("key".to_string()));

pub fn enrich_with_keys(self, keys: &CompoundKey) -> Self

Enriches error context with a complex path.

Used to put more contextual information in the error to facilitate debugging issues. One can put information about location in configuration tree in error with this function.

pub fn pretty_display(&self) -> PrettyConfigurationDisplay<'_>

Returns an object that displays error in pretty way.

Example

use miau::error::{ConfigurationError, ErrorCode};
use miau::configuration::Key;

let error: ConfigurationError = ErrorCode::NullValue.into();

println!("Basic display : {}", error);
println!("Pretty display : {}", error.pretty_display());

Methods from Deref<Target = ErrorImpl>

pub fn get_code(&self) -> &ErrorCode

Returns reference to underlying cause of the error.

pub fn get_path(&self) -> Option<&[Key]>

Returns path in configuration at which error occured.

Returned value is a slice with configuration keys counting from root.

pub fn get_context(&self) -> Option<&[String]>

Returns additional context attached to error.

This information can contain, for instance, name of the file that was not found.

Trait Implementations

impl Debug for ConfigurationError

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

Formats the value using the given formatter.

impl Deref for ConfigurationError

type Target = ErrorImpl

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ConfigurationError

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

Formats the value using the given formatter.

impl Error for ConfigurationError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl Error for ConfigurationError

fn custom<T>(msg: T) -> Self where
    T: Display, 

Raised when there is general error when deserializing a type.

pub fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

pub fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

pub fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

pub fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

pub fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

pub fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

pub fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl From<Error> for ConfigurationError

fn from(e: Error) -> Self

Performs the conversion.

impl From<ErrorCode> for ConfigurationError

fn from(e: ErrorCode) -> Self

Performs the conversion.