Enum ciborium::de::Error

pub enum Error<T> {
    Io(T),
    Syntax(usize),
    Semantic(Option<usize>, String),
}

An error occurred during deserialization

Variants

Io(T)

An error occurred while reading bytes

Contains the underlying error reaturned while reading.

Syntax(usize)

An error occurred while parsing bytes

Contains the offset into the stream where the syntax error occurred.

Semantic(Option<usize>, String)

An error occurred while processing a parsed value

Contains a description of the error that occurred and (optionally) the offset into the stream indicating the start of the item being processed when the error occurred.

Implementations

impl<T> Error<T>

pub fn semantic(
    offset: impl Into<Option<usize>>,
    msg: impl Into<String>
) -> Self

A helper method for composing a semantic error

Trait Implementations

impl<T: Debug> Debug for Error<T>

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

Formats the value using the given formatter.

impl<T: Debug> Display for Error<T>

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

Formats the value using the given formatter.

impl<T: Debug> Error for Error<T>

pub 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<T: Debug> Error for Error<T>

pub fn custom<U: Display>(msg: U) -> Self

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<T> From<T> for Error<T>

pub fn from(value: T) -> Self

Performs the conversion.