Enum DecodeError 

pub enum DecodeError {
    Truncated {
        offset: usize,
    },
    LengthMismatch {
        offset: usize,
        expected: usize,
        available: usize,
    },
    UnknownOpcode {
        byte: u8,
        offset: usize,
    },
    UnknownValueTag {
        tag: u8,
        offset: usize,
    },
    InvalidString,
    ReservedClockSentinel {
        offset: usize,
    },
    UnknownSymbolKind {
        ordinal: u8,
        offset: usize,
    },
    BodyUnderflow {
        opcode: Opcode,
        offset: usize,
        consumed: usize,
        declared: usize,
    },
    VarintOverflow {
        offset: usize,
    },
    NonCanonicalVarint {
        offset: usize,
    },
    InvalidFlagBits {
        byte: u8,
        allowed_mask: u8,
        offset: usize,
    },
    InvalidDiscriminant {
        field: &'static str,
        tag: u8,
        offset: usize,
    },
}

Errors produced by decode_record.

Variants

Truncated

The input ended before the record was fully decoded.

Fields

offset: usize

Byte offset where truncation was detected.

LengthMismatch

The length-prefix said the body extended past the input.

Fields

offset: usize

Byte offset of the record.

expected: usize

Declared body length.

available: usize

Bytes available after the length prefix.

UnknownOpcode

Opcode byte is not in the registered set.

Fields

byte: u8

The offending byte.

offset: usize

Offset of the byte.

UnknownValueTag

Value-tag byte is not in 0x01..=0x06.

Fields

tag: u8

The offending tag.

offset: usize

Offset of the tag.

InvalidString

A string value was not valid UTF-8.

ReservedClockSentinel

A ClockTime field on the wire carried the u64::MAX reserved sentinel, which ClockTime refuses to construct. Only the invalid_at slot is permitted to be None; every other clock field must be a concrete millisecond value.

Fields

offset: usize

Offset of the first sentinel byte.

UnknownSymbolKind

A symbol-kind ordinal byte did not correspond to any variant.

Fields

ordinal: u8

The offending byte.

offset: usize

Offset of the byte.

BodyUnderflow

Record body declared more bytes than the body contained.

Fields

opcode: Opcode

The opcode being decoded.

offset: usize

Body offset inside the frame.

consumed: usize

Bytes consumed so far.

declared: usize

Declared body length.

VarintOverflow

Varint decoding overflowed the target type (more than 10 bytes for u64).

Fields

offset: usize

Offset of the varint.

NonCanonicalVarint

Varint was well-formed but not encoded with the shortest byte sequence.

Fields

offset: usize

Offset of the varint.

InvalidFlagBits

Reserved flag bits were set in a record flag byte.

Fields

byte: u8

The offending flag byte.

allowed_mask: u8

Mask of allowed flag bits for this record kind.

offset: usize

Offset of the flag byte.

InvalidDiscriminant

A field discriminant carried a value outside its canonical set.

Fields

field: &'static str

Name of the field being decoded.

tag: u8

The offending discriminant byte.

offset: usize

Offset of the discriminant byte.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

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 From<DecodeError> for StoreError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl PartialEq for DecodeError

fn eq(&self, other: &DecodeError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DecodeError

impl StructuralPartialEq for DecodeError