Enum EnvelopeCodecError 

#[non_exhaustive]
pub enum EnvelopeCodecError {
    PayloadEncode(String),
    EnvelopeEncode(String),
    EnvelopeDecode(String),
    PayloadDecode(String),
    Compress(String),
    Decompress(String),
    WalSegmentTooLarge {
        max_bytes: usize,
    },
    InvalidWalInlineContent {
        seq: ChangeSeq,
        content_id: ContentId,
        reason: &'static str,
    },
    UnknownKind {
        found: String,
    },
    KindMismatch {
        expected: String,
        found: String,
    },
    UnsupportedFormatVersion {
        kind: String,
        found: u32,
        supported: u32,
    },
    ChecksumMismatch {
        expected: String,
        actual: String,
    },
}

Failure vocabulary shared by every envelope codec. Messages are envelope-generic; the wrapping error names the object (and its key) the bytes came from.

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.

PayloadEncode(String)

Reports a payload that cannot be serialized into its family’s durable encoding.

EnvelopeEncode(String)

Reports an envelope document that cannot be serialized around an encoded payload.

EnvelopeDecode(String)

Reports bytes that do not decode as the shared durable envelope layout.

PayloadDecode(String)

Reports a verified envelope whose opaque payload does not decode as its declared family.

Compress(String)

Reports an envelope that the configured transport codec could not compress.

Decompress(String)

Reports stored bytes that the configured transport codec could not decompress.

WalSegmentTooLarge

Reports a WAL document that exceeds the decompressed format limit.

Fields

max_bytes: usize

Largest accepted decompressed document.

InvalidWalInlineContent

Reports inline content that violates the WAL format rules.

Fields

seq: ChangeSeq

Commit containing the rejected entry.

content_id: ContentId

Content whose entry violates a rule or exceeds the segment total.

reason: &'static str

Format rule violated by the entry.

UnknownKind

Reports an unrecognized durable-family discriminator found during the envelope probe.

Fields

found: String

Untrusted kind spelling decoded from the stored object.

KindMismatch

Reports a valid discriminator that does not belong to the decoder the caller selected.

Fields

expected: String

Durable family the selected decoder accepts.

found: String

Durable family declared by the stored object.

UnsupportedFormatVersion

Reports a known durable family whose format version this build cannot read.

Fields

kind: String

Durable family whose independent version gate rejected the object.

found: u32

Version declared by the stored object.

supported: u32

Sole version this build reads and writes for kind.

ChecksumMismatch

Reports stored payload bytes that do not match the checksum recorded beside them.

Fields

expected: String

Digest recorded in the durable envelope.

actual: String

Digest recomputed over the exact stored payload bytes.

Trait Implementations

impl Debug for EnvelopeCodecError

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

Formats the value using the given formatter.

impl Display for EnvelopeCodecError

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

Formats the value using the given formatter.

impl Error for EnvelopeCodecError

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.