Enum EnvelopeError 

#[non_exhaustive]
pub enum EnvelopeError {
    Truncated {
        needed: usize,
        got: usize,
    },
    BadMagic {
        expected: [u8; 4],
        found: [u8; 4],
    },
    VersionMismatch {
        expected: u32,
        found: u32,
    },
    SectionTooLarge {
        len: usize,
        max: usize,
    },
}

Errors returned from WireReader decode operations. Variants are non-exhaustive so additive framing variants stay backward-compatible.

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

Payload ended before the requested section was fully read.

Fields

needed: usize

Byte offset the decoder needed to reach.

got: usize

Bytes actually present in the input slice.

BadMagic

First four bytes did not match the consumer’s expected magic.

Fields

expected: [u8; 4]

Magic the consumer expected.

found: [u8; 4]

Magic actually present in the blob.

VersionMismatch

Wire version header did not match the consumer’s expected version. Primary signal for cache invalidation: a VersionMismatch is the consumer’s cue to discard the cache and recompile from source.

Fields

expected: u32

Wire version the consumer’s build understands.

found: u32

Wire version recorded in the blob’s header.

SectionTooLarge

A section or word-array length could not fit in the envelope’s u32 length prefix.

Fields

len: usize

Length the caller attempted to encode.

max: usize

Maximum length representable by the wire format.

Trait Implementations

impl Clone for EnvelopeError

fn clone(&self) -> EnvelopeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeError

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

Formats the value using the given formatter.

impl Display for EnvelopeError

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

Formats the value using the given formatter.

impl Error for EnvelopeError

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.