Enum EncodingError

#[non_exhaustive]
pub enum EncodingError {
    IOError(ErrorKind),
    UnexpectedEnd,
    SeekError(SeekError),
    VarIntError,
    InvalidBool,
    StringError(StringError),
    MaxSizeExceeded {
        max: usize,
        requested: usize,
    },
    InvalidVariant(Opaque),
    TooLarge {
        value: Opaque,
        requested_width: BitWidth,
    },
    SignMismatch {
        expected: Signedness,
        got: Signedness,
    },
    FlattenError(FlattenError),
    LockError,
    BorrowError(BorrowError),
    ValidationError(String),
    SerdeError(String),
}

Represents any kind of error that can happen during encoding and decoding

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.

IOError(ErrorKind)

Generic IO error

UnexpectedEnd

The end of the file or buffer was reached but more data was expected

SeekError(SeekError)

An error involving the seek operation occurred.

VarIntError

A var-int was malformed and could not be decoded

InvalidBool

A value other than 1 or 0 was read while decoding a bool

StringError(StringError)

An attempt was made to encode or decode a string, but something went wrong.

MaxSizeExceeded

Tried to write or read a usize greater than the max

Fields

max: usize

requested: usize

InvalidVariant(Opaque)

Tried to decode an unrecognized enum variant

TooLarge

Tried to squeeze a value into fewer bits than what is required to fully represent it.

Fields

value: Opaque

requested_width: BitWidth

SignMismatch

Expected to get a value with a specific signedness, but got one with the opposite. E.G. Expected an u8 but got an i8.

Fields

expected: Signedness

got: Signedness

FlattenError(FlattenError)

An attempt was made to flatten an option or result, but the inner value was unexpected. Example: #[ender(flatten: some)] applied on an Option containing the None variant

LockError

An attempt was made to lock a RefCell/Mutex/RwLock or similar, but it failed.

BorrowError(BorrowError)

A piece of data couldn’t be borrowed from the encoder. This is a recoverable error, meaning the decoding operation can be attempted again with a non-borrowing function.

ValidationError(String)

A #[ender(validate = ...)] check failed

SerdeError(String)

Available on crate feature serde only.

A generic serde error occurred

Implementations

impl EncodingError

pub fn validation_error<'a>(fmt: Arguments<'a>) -> Self

pub fn invalid_variant<V>(v: V) -> Self

where Opaque: From<V>,

Trait Implementations

impl Debug for EncodingError

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

Formats the value using the given formatter.

impl Display for EncodingError

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

Formats the value using the given formatter.

impl Error for EncodingError

fn kind(&self) -> ErrorKind

Get the kind of this error.

impl Error for EncodingError

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 EncodingError

fn custom<Msg>(_msg: Msg) -> Self

where Msg: Display,

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

impl Error for EncodingError

fn custom<Msg>(_msg: Msg) -> Self

where Msg: 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<BorrowError> for EncodingError

fn from(value: BorrowError) -> Self

Converts to this type from the input type.

impl From<Error> for EncodingError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for EncodingError

fn from(value: ErrorKind) -> Self

Converts to this type from the input type.

impl From<FlattenError> for EncodingError

fn from(value: FlattenError) -> Self

Converts to this type from the input type.

impl<T: Error> From<ReadExactError<T>> for EncodingError

fn from(value: ReadExactError<T>) -> Self

Converts to this type from the input type.

impl From<SeekError> for EncodingError

fn from(value: SeekError) -> Self

Converts to this type from the input type.

impl From<StringError> for EncodingError

fn from(value: StringError) -> Self

Converts to this type from the input type.