Enum CodecError 

#[non_exhaustive]
pub enum CodecError {
    UnexpectedEof {
        needed: usize,
    },
    BadMagic,
    UnsupportedVersion(u8),
    LengthOverflow {
        claimed: u64,
        remaining: usize,
    },
    CountOverflow {
        claimed: u64,
        max: usize,
    },
    InvalidUtf8,
    InvalidBool(u8),
    InvalidOption(u8),
    InvalidChar(u32),
    UnknownVariant(u32),
    MissingLen,
    TrailingBytes(usize),
    SelfDescribing,
    Message(String),
}

Errors returned by the event-store positional codec.

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.

UnexpectedEof

The input ended before the requested bytes could be read.

Fields

needed: usize

Number of bytes the decoder attempted to read.

BadMagic

The frame did not start with the event-store codec magic.

UnsupportedVersion(u8)

The frame version is not supported by this decoder.

LengthOverflow

An encoded byte length would exceed the remaining input.

Fields

claimed: u64

Claimed encoded byte length, as the raw on-wire u64.

Kept as u64 (not usize) so the reported value is exact on every target, including a length that overflows usize on a sub-64-bit build — the case that would otherwise be reported with a lossy sentinel.

remaining: usize

Bytes remaining in the input when the length was checked.

CountOverflow

An encoded collection count exceeded the supported maximum.

Fields

claimed: u64

Claimed collection count, as the raw on-wire u64.

max: usize

Maximum supported collection count.

InvalidUtf8

A string was not valid UTF-8.

InvalidBool(u8)

A bool discriminant was not 0x00 or 0x01.

InvalidOption(u8)

An option discriminant was not 0x00 or 0x01.

InvalidChar(u32)

A decoded char value was not a valid Unicode scalar value.

UnknownVariant(u32)

An enum variant index was outside the type’s variant set.

MissingLen

Serde did not provide a sequence or map length.

TrailingBytes(usize)

The input had bytes remaining after a complete value was decoded.

SelfDescribing

The caller attempted self-describing deserialization.

Message(String)

Serde-generated error message.

Trait Implementations

impl Debug for CodecError

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

Formats the value using the given formatter.

impl Display for CodecError

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

Formats the value using the given formatter.

impl Error for CodecError

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 CodecError

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

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

impl Error for CodecError

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

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.