Enum FrameError 

#[non_exhaustive]
pub enum FrameError {
    UnsupportedVersion(u8),
    UnknownFrameType(u8),
    PayloadTooLarge {
        requested: usize,
        limit: usize,
    },
    Decompression(String),
    DecompressedTooLarge {
        limit: usize,
    },
    Compression(String),
}

Errors that can occur while encoding or decoding a Lumberjack v2 frame.

All variants are non-exhaustive in spirit: future versions of the codec may add new variants without bumping the major version while in the v0.0.x series.

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.

UnsupportedVersion(u8)

Wire byte 0 is not b'2'. The decoder refuses to advance because it cannot determine which protocol version applies.

UnknownFrameType(u8)

Wire byte 1 is not a known frame type.

PayloadTooLarge

A length field declared a frame larger than crate::DEFAULT_MAX_FRAME_PAYLOAD (or the configured per-decoder limit). Surfaces resource-exhaustion attacks before the decoder allocates.

Fields

requested: usize

Length declared on the wire.

limit: usize

Configured cap for this decoder.

Decompression(String)

Decompression failed (C frame had invalid zlib content).

DecompressedTooLarge

The decompressed contents of a C frame would exceed the per-decoder size limit. Caps zlib-bomb input.

Fields

limit: usize

Configured cap for this decoder.

Compression(String)

The compressor returned an error while encoding (typically out of memory). Returned only by crate::encode_compressed.

Trait Implementations

impl Debug for FrameError

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

Formats the value using the given formatter.

impl Display for FrameError

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

Formats the value using the given formatter.

impl Error for FrameError

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.

impl From<FrameError> for ProtocolError

fn from(source: FrameError) -> Self

Converts to this type from the input type.