Enum Error 

pub enum Error {
    InvalidUtf8 {
        location: Box<Location>,
    },
    UnsupportedType {
        text: String,
        location: Box<Location>,
        found: &'static str,
    },
    Parse {
        text: String,
        location: Option<Box<Location>>,
        message: String,
    },
    Deserialize {
        text: String,
        message: String,
        location: Option<Box<Location>>,
    },
}

Error while deserializing configuration input.

Display is one line by default; use {error:#} for source context and caret.

Location is boxed so the whole Error stays small enough to return by value without tripping clippy::result_large_err (a Location now carries the full originating tanzim_source::Source).

Variants

InvalidUtf8

Fields

location: Box<Location>

UnsupportedType

Fields

text: String

location: Box<Location>

found: &'static str

Parse

Fields

text: String

location: Option<Box<Location>>

message: String

Deserialize

A value could not be deserialized into the requested type (serde Cargo feature).

text holds the raw source of the offending value’s origin (empty until supplied via Error::with_source_text); when present, {error:#} renders a caret underline.

Fields

text: String

message: String

location: Option<Box<Location>>

Implementations

impl Error

pub fn deserialize_location(&self) -> Option<&Location>

The Location of a located Error::Deserialize, if any. Lets a caller (e.g. the pipeline) look up the originating source and fill in Error::with_source_text.

pub fn with_source_text(self, text: impl Into<String>) -> Self

Attach the raw source text of the offending value’s origin to a Error::Deserialize (only if it has none yet), so {error:#} can render a source snippet with a caret.

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, 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>(message: T) -> Self

Raised when there is general error when deserializing a type.

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 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 duplicate_field(field: &'static str) -> Self

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

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