Enum ssz::DecodeError

pub enum DecodeError {
    InvalidByteLength {
        len: usize,
        expected: usize,
    },
    InvalidLengthPrefix {
        len: usize,
        expected: usize,
    },
    OutOfBoundsByte {
        i: usize,
    },
    OffsetIntoFixedPortion(usize),
    OffsetSkipsVariableBytes(usize),
    OffsetsAreDecreasing(usize),
    OffsetOutOfBounds(usize),
    InvalidListFixedBytesLen(usize),
    ZeroLengthItem,
    BytesInvalid(String),
    UnionSelectorInvalid(u8),
    NoMatchingVariant,
}

Returned when SSZ decoding fails.

Variants

InvalidByteLength

The bytes supplied were too short to be decoded into the specified type.

Fields

len: usize

expected: usize

InvalidLengthPrefix

The given bytes were too short to be read as a length prefix.

Fields

len: usize

expected: usize

OutOfBoundsByte

A length offset pointed to a byte that was out-of-bounds (OOB).

A bytes may be OOB for the following reasons:

• It is >= bytes.len().
• When decoding variable length items, the 1st offset points “backwards” into the fixed length items (i.e., length[0] < BYTES_PER_LENGTH_OFFSET).
• When decoding variable-length items, the n’th offset was less than the n-1’th offset.

Fields

i: usize

OffsetIntoFixedPortion(usize)

An offset points “backwards” into the fixed-bytes portion of the message, essentially double-decoding bytes that will also be decoded as fixed-length.

https://notes.ethereum.org/ruKvDXl6QOW3gnqVYb8ezA?view#1-Offset-into-fixed-portion

OffsetSkipsVariableBytes(usize)

The first offset does not point to the byte that follows the fixed byte portion, essentially skipping a variable-length byte.

https://notes.ethereum.org/ruKvDXl6QOW3gnqVYb8ezA?view#2-Skip-first-variable-byte

OffsetsAreDecreasing(usize)

An offset points to bytes prior to the previous offset. Depending on how you look at it, this either double-decodes bytes or makes the first offset a negative-length.

https://notes.ethereum.org/ruKvDXl6QOW3gnqVYb8ezA?view#3-Offsets-are-decreasing

OffsetOutOfBounds(usize)

An offset references byte indices that do not exist in the source bytes.

https://notes.ethereum.org/ruKvDXl6QOW3gnqVYb8ezA?view#4-Offsets-are-out-of-bounds

InvalidListFixedBytesLen(usize)

A variable-length list does not have a fixed portion that is cleanly divisible by BYTES_PER_LENGTH_OFFSET.

ZeroLengthItem

Some item has a ssz_fixed_len of zero. This is illegal.

BytesInvalid(String)

The given bytes were invalid for some application-level reason.

UnionSelectorInvalid(u8)

The given union selector is out of bounds.

NoMatchingVariant

The given bytes could not be successfully decoded into any variant of the transparent enum.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a copy 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 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 StructuralPartialEq for DecodeError