Enum Error 

#[non_exhaustive]
pub enum Error {
    Custom(String),
    Io(Error),
    InvalidKey,
    UnsupportedDataType(SpecialType),
    WrongType {
        expected: &'static str,
        found: &'static str,
    },
    MismatchedKeyType {
        expected: ObjectKind,
        found: ObjectKind,
    },
    MismatchedElementType {
        expected: ArrayKind,
        found: ArrayKind,
    },
    TooLong,
    InvalidHeader(u8),
    Utf8(Utf8Error),
    FromUtf8(FromUtf8Error),
    Reserved,
    InvalidTag,
    NoChar,
    InvalidComplexHeader,
    InvalidMatrixType,
}

Errors that can occur during serialization or deserialization.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Custom(String)

A custom error message.

This variant is never directly constructed by this library, but rather is used for serde’s Error traits¹.

---

1. serde::ser::Error and serde::de::Error ↩

Io(Error)

An IO error produced by an internal Reader or Writer.

InvalidKey

Returned when attempting to serialize an object key that is not a string or integer.

UnsupportedDataType(SpecialType)

Returned when trying to deserialize an unsupported data type.

This can occur when trying to deserialize an f16 or a bf16 without the half feature enabled. It can also occur when trying to deserialize a 128-bit float, as these are not yet stable in Rust.

WrongType

Returned when a type is found during deserialization that doesn’t match the expected type (e.g. deserialize_u8 is called but a u16 header is encountered).

Fields

expected: &'static str

found: &'static str

MismatchedKeyType

Returned when, during the serialization or deserialization of an object, a key is encountered that doesn’t match the first encountered key. Returned when, during the serialization or deserialization of an object, a key is

Objects in BEVE can be keyed by strings or integers, but all fields must be of the same type.

Fields

expected: ObjectKind

found: ObjectKind

MismatchedElementType

Fields

expected: ArrayKind

found: ArrayKind

TooLong

Returned either when trying to serialize data whose size is greater than (2^62)-1 bits or when trying to deserialize a size that is larger than the platform’s pointer width (e.g. trying to deserialize a 62-bit size on a 32-bit platform).

InvalidHeader(u8)

Returned when a header is encountered that does not fit the BEVE format.

Utf8(Utf8Error)

Returned when the deserialization of a str fails.

FromUtf8(FromUtf8Error)

Returned when the deserialization of a String fails.

Reserved

Returned when attempting to deserialize a reserved header.

InvalidTag

Returned when attempting to deserialize an enum tag as something other than an identifier.

NoChar

Returned when an empty string is attempted to be deserialized as a character.

InvalidComplexHeader

Returned when an invalid complex header is encountered.

InvalidMatrixType

Returned when attempting to deserialize part of a matrix as an improper type.

Trait Implementations

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, __formatter: &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>(msg: T) -> Self

where T: Display,

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

impl Error for Error

fn custom<T>(msg: T) -> Self

where T: Display,

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.