Enum Error 

pub enum Error {
    BufferTooSmall {
        required: usize,
        provided: usize,
    },
    BadMagic,
    BadHeaderLen {
        header_len: usize,
    },
    BadPayloadLen {
        payload_len: usize,
    },
    Truncated,
    UnknownFlags {
        flags: u16,
    },
}

Errors returned by v1 envelope encode/decode helpers.

These errors reflect structural problems with the envelope (magic bytes, lengths, and flag bits). They do not indicate anything about the correctness or meaning of the payload bytes beyond the declared length.

Variants

BufferTooSmall

Output buffer is smaller than required.

Fields

required: usize

Minimum number of bytes required.

provided: usize

Number of bytes provided by the caller.

BadMagic

Magic bytes did not match the expected v1 envelope prefix.

BadHeaderLen

Header length is invalid or unsupported.

Fields

header_len: usize

Decoded/declared header length in bytes.

BadPayloadLen

Payload length is invalid (e.g. would overflow slot capacity).

Fields

payload_len: usize

Decoded/declared payload length in bytes.

Truncated

Input did not contain enough bytes to decode a full header/payload.

UnknownFlags

Header contains unknown/unsupported flag bits.

Fields

flags: u16

Flag bits that were not recognized.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl PartialEq for Error

fn eq(&self, other: &Error) -> 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 Copy for Error

impl Eq for Error

impl StructuralPartialEq for Error