Enum CapsuleDecodeError 

#[non_exhaustive]
pub enum CapsuleDecodeError {
    Truncated {
        required: usize,
        available: usize,
    },
    InvalidMagic,
    UnsupportedCodec {
        major: u16,
        minor: u16,
    },
    NonCanonicalLength {
        declared_body_len: u32,
        actual_body_len: usize,
    },
    MissingSection {
        tag: u16,
    },
    SectionOutOfOrder {
        tag: u16,
    },
    UnknownSection {
        tag: u16,
    },
    NonCanonicalSectionLength {
        tag: u16,
        declared: u32,
    },
    NonCanonicalSection {
        tag: u16,
    },
    ParticipantOutOfOrder {
        participant_id: ParticipantId,
    },
    ForeignConversation {
        tag: u16,
    },
    TrailingBytes {
        trailing: usize,
    },
    LengthOverflow,
}

Stable canonical capsule-decode failure.

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.

Truncated

Fewer bytes than the fixed envelope or selected field requires.

Fields

required: usize

Minimum bytes required at the detected boundary.

available: usize

Bytes supplied by the caller.

InvalidMagic

The capsule does not begin with the assigned LPCK magic prefix.

UnsupportedCodec

The capsule codec version is not supported by this crate.

Fields

major: u16

Presented codec major version.

minor: u16

Presented codec minor version.

NonCanonicalLength

The declared body length differs from the bytes supplied after the fixed header.

Fields

declared_body_len: u32

Length declared in the envelope.

actual_body_len: usize

Bytes supplied after the fixed header.

MissingSection

The body ended before a section the canonical order requires.

Fields

tag: u16

Tag of the first absent section.

SectionOutOfOrder

A known section appeared where the canonical order has another.

Fields

tag: u16

Tag of the misplaced section.

UnknownSection

A section tag is unassigned.

Fields

tag: u16

Unrecognized section tag.

NonCanonicalSectionLength

A section’s declared length is not its canonical length.

Fields

tag: u16

Tag of the section.

declared: u32

Length the section declared.

NonCanonicalSection

A complete section violates a field invariant.

Fields

tag: u16

Tag of the section whose invariants failed.

ParticipantOutOfOrder

The participants section is not strictly ascending by participant id.

Fields

participant_id: ParticipantId

The first participant id not above its predecessor.

ForeignConversation

A section names another conversation than the capsule header.

Fields

tag: u16

Tag of the section naming the other conversation.

TrailingBytes

Bytes remain after the last canonical section.

Fields

trailing: usize

Bytes after the last section.

LengthOverflow

A platform length conversion or offset addition overflowed.

Trait Implementations

impl Clone for CapsuleDecodeError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CapsuleDecodeError

impl Debug for CapsuleDecodeError

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

Formats the value using the given formatter.

impl Eq for CapsuleDecodeError

impl PartialEq for CapsuleDecodeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CapsuleDecodeError