Struct sea_orm_rocket::figment::Error

pub struct Error {
    pub profile: Option<Profile>,
    pub metadata: Option<Metadata>,
    pub path: Vec<String, Global>,
    pub kind: Kind,
    // some fields omitted
}

An error that occured while producing data or extracting a configuration.

Constructing Errors

An Error will generally be constructed indirectly via its implementations of serde’s de::Error and ser::Error, that is, as a result of serialization or deserialization errors. When implementing Provider, however, it may be necessary to construct an Error directly.

Broadly, there are two ways to construct an Error:

• Via an error message, since Error impls From<String>:

  use figment::Error;
  
  Error::from("whoops, something went wrong!".to_string());

• Via a Kind, since Error impls From<Kind>:

  use figment::{error::{Error, Kind}, value::Value};
  
  let value = Value::serialize(&100).unwrap();
  if !value.as_str().is_some() {
      let kind = Kind::InvalidType(value.to_actual(), "string".into());
      let error = Error::from(kind);
  }

As always, ? can be used to automatically convert into an Error using the available From implementations:

use std::fs::File;

fn try_read() -> Result<(), figment::Error> {
    let x = File::open("/tmp/foo.boo").map_err(|e| e.to_string())?;
    Ok(())
}

Display

By default, Error uses all of the available information about the error, including the Metadata, path, and profile to display a message that resembles the following, where $ is error. for some error: Error:

$kind: `$metadata.interpolate($path)` in $($metadata.sources())*

Concretely, such an error may look like:

invalid type: found sequence, expected u16: `staging.port` in TOML file Config.toml

Iterator

An Error may contain more than one error. To process all errors, iterate over an Error:

fn with_error(error: figment::Error) {
    for error in error {
        println!("error: {}", error);
    }
}

Fields

profile: Option<Profile>

The profile that was selected when the error occured, if any.

metadata: Option<Metadata>

The metadata for the provider of the value that errored, if known.

path: Vec<String, Global>

The path to the configuration key that errored, if known.

kind: Kind

The error kind.

Implementations

impl Error

pub fn missing(&self) -> bool

Returns true if the error’s kind is MissingField.

Example

use figment::error::{Error, Kind};

let error = Error::from(Kind::MissingField("path".into()));
assert!(error.missing());

pub fn with_path(self, path: &str) -> Error

Append the string path to the error’s path.

Example

use figment::Error;

let error = Error::from("an error message".to_string())
    .with_path("some_path");

pub fn count(&self) -> usize

Returns the number of errors represented by self.

Example

use figment::{Figment, providers::{Format, Toml}};

figment::Jail::expect_with(|jail| {
    jail.create_file("Base.toml", r#"
        cat = [1
    "#)?;

    jail.create_file("Release.toml", r#"
        cat = "
    "#)?;

    let figment = Figment::from(Toml::file("Base.toml"))
        .merge(Toml::file("Release.toml"));

    let error = figment.extract_inner::<String>("cat").unwrap_err();
    assert_eq!(error.count(), 2);

    Ok(())
});

Trait Implementations

impl Clone for Error

pub fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Raised when there is general error when deserializing a type.

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

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

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

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) -> Error

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]
) -> Error

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

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

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

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

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) -> Error

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

impl Error for Error

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

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

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

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

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

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

impl Error for Error

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

Used when a Serialize implementation encounters any error while serializing a type.

impl<A, B> From<Error> for Error<A, B>

fn from(e: Error) -> Self

Performs the conversion.

impl From<Kind> for Error

pub fn from(kind: Kind) -> Error

Performs the conversion.

impl From<String> for Error

pub fn from(string: String) -> Error

Performs the conversion.

impl IntoIterator for Error

type Item = Error

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <Error as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Error