Struct Error 

pub struct Error { /* private fields */ }

A configuration error.

Boxed internally so that Result<T, Error> stays small on the hot path — load is called on every reload, and most calls succeed.

Implementations

impl Error

pub fn invalid<E: Display>(error: E) -> Self

A configuration that parsed but failed its own validation.

Called by the code #[dynamic_config(.., validate)] generates, from whatever validate resolves to at the call site.

pub fn ok_or_invalid<T, E: Display>(outcome: Result<T, E>) -> Result<(), Self>

Maps a validation result into a load failure.

Takes the whole Result rather than the error, so the generated code is one expression regardless of what validate returns.

Errors

If outcome is Err.

pub fn remote<E: Display>(error: E) -> Self

A remote store that could not be read.

For implementors of RemoteSource, so a network failure is categorised the same way whichever store it came from.

pub fn decrypt<E: Display>(error: E) -> Self

A failure decrypting an encrypted config file.

For Decryptor implementations, so a scheme this crate has never heard of still reports through the same category.

pub fn unsupported(path: &Path) -> Self

A path whose extension names no format this build can write.

pub fn kind(&self) -> ErrorKind

The error’s category.

pub fn path(&self) -> String

The dotted key path this error occurred at, empty at the root.

pub fn origin(&self) -> &Origin

Where the offending value came from.

pub fn message(&self) -> &str

The detail message, without the path or origin decoration.

Trait Implementations

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, f: &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 Error for Error

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

Raised when there is general error when deserializing a type.

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.

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

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

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.

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.

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

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

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

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

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

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