Struct serde_cbor::error::Error

pub struct Error(_);

This type represents all possible errors that can occur when serializing or deserializing CBOR data.

Implementations

impl Error

pub fn offset(&self) -> u64

The byte offset at which the error occurred.

pub fn classify(&self) -> Category

Categorizes the cause of this error.

pub fn is_io(&self) -> bool

Returns true if this error was caused by a failure to read or write bytes on an IO stream.

pub fn is_syntax(&self) -> bool

Returns true if this error was caused by input that was not syntactically valid CBOR.

pub fn is_data(&self) -> bool

Returns true if this error was caused by data that was semantically incorrect.

pub fn is_eof(&self) -> bool

Returns true if this error was caused by prematurely reaching the end of the input data.

pub fn is_scratch_too_small(&self) -> bool

Returns true if this error was caused by the scratch buffer being too small.

Note this being true implies that is_io() is also true.

Trait Implementations

impl Debug for Error

fn fmt(&self, fmt: &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)>

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 Error

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

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

impl Error for Error

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

Raised when there is general error when deserializing a type.

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

fn from(e: Error) -> Error

Performs the conversion.