Struct Error

pub struct Error(/* private fields */);

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

Creates an error signalling that the underlying Read encountered an I/O error.

pub fn scratch_too_small(offset: u64) -> Error

Creates an error signalling that the scratch buffer was too small to fit the data.

pub fn message<T: Display>(_msg: T) -> Error

Creates an error with a custom message.

Note: When the “std” feature is disabled, the message will be discarded.

pub fn eof(offset: u64) -> Error

Creates an error signalling that the underlying read encountered an end of input.

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 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.

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

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

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

impl From<Error> for Error

fn from(_: Error) -> Error

Converts to this type from the input type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes