Enum FrameDecoderError 

#[non_exhaustive]
pub enum FrameDecoderError {
    ReadFrameHeaderError(ReadFrameHeaderError),
    FrameHeaderError(FrameHeaderError),
    WindowSizeTooBig {
        requested: u64,
    },
    DictionaryDecodeError(DictionaryDecodeError),
    FailedToReadBlockHeader(BlockHeaderReadError),
    FailedToReadBlockBody(DecodeBlockContentError),
    FailedToReadChecksum(Error),
    NotYetInitialized,
    FailedToInitialize(FrameHeaderError),
    FailedToDrainDecodebuffer(Error),
    FailedToSkipFrame,
    TargetTooSmall,
    FrameContentSizeMismatch {
        declared: u64,
        produced: u64,
    },
    DictNotProvided {
        dict_id: u32,
    },
    DictIdMismatch {
        expected: u32,
        provided: u32,
    },
    DictAlreadyRegistered {
        dict_id: u32,
    },
    UnexpectedDictId {
        expected: Option<u32>,
        found: Option<u32>,
    },
    UnexpectedWindowDescriptor {
        expected: u8,
        found: Option<u8>,
    },
}

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.

ReadFrameHeaderError(ReadFrameHeaderError)

FrameHeaderError(FrameHeaderError)

WindowSizeTooBig

Fields

requested: u64

DictionaryDecodeError(DictionaryDecodeError)

FailedToReadBlockHeader(BlockHeaderReadError)

FailedToReadBlockBody(DecodeBlockContentError)

FailedToReadChecksum(Error)

NotYetInitialized

FailedToInitialize(FrameHeaderError)

FailedToDrainDecodebuffer(Error)

FailedToSkipFrame

TargetTooSmall

FrameContentSizeMismatch

Decoded block sizes don’t sum to the frame’s declared frame_content_size (either a block claims to expand past FCS, or the stream ends before reaching FCS). Indicates a malformed or corrupt frame — distinct from Self::TargetTooSmall (which is the caller’s responsibility) so callers can tell decoder-side issues apart from their own buffer sizing mistakes.

Fields

declared: u64

produced: u64

DictNotProvided

Fields

dict_id: u32

DictIdMismatch

Fields

expected: u32

provided: u32

DictAlreadyRegistered

Fields

dict_id: u32

UnexpectedDictId

Available on crate feature lsm only.

Frame header’s dict_id did not match the value pinned via FrameDecoder::expect_dict_id. Returned BEFORE any block decode and BEFORE any output is produced — no XXH64 init, no partial output. Scratch buffer allocation / reservation for the decode pipeline happens during frame-header parsing, which is already complete when this validation fires, so the cost of scratch sizing is paid even on a mismatched header. expected is the pinned value (Some(0) is treated as “no dictionary expected”, matching a frame whose header omits the optional Dictionary_ID field); found reports what the frame actually carried (None when the header omits the field, Some(id) when it does not).

Fields

expected: Option<u32>

found: Option<u32>

UnexpectedWindowDescriptor

Available on crate feature lsm only.

Frame header’s raw Window_Descriptor byte did not match the value pinned via FrameDecoder::expect_window_descriptor. Returned BEFORE any block decode work. Single-segment frames (which omit the Window_Descriptor byte from the wire) are reported via found: None so callers can distinguish “wrong descriptor” from “no descriptor on the wire”.

Fields

expected: u8

found: Option<u8>

Trait Implementations

impl Debug for FrameDecoderError

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

Formats the value using the given formatter.

impl Display for FrameDecoderError

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

Formats the value using the given formatter.

impl Error for FrameDecoderError

Available on crate feature std only.

fn source(&self) -> Option<&(dyn StdError + '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<BlockHeaderReadError> for FrameDecoderError

fn from(val: BlockHeaderReadError) -> Self

Converts to this type from the input type.

impl From<DictionaryDecodeError> for FrameDecoderError

fn from(val: DictionaryDecodeError) -> Self

Converts to this type from the input type.

impl From<FrameHeaderError> for FrameDecoderError

fn from(val: FrameHeaderError) -> Self

Converts to this type from the input type.

impl From<ReadFrameHeaderError> for FrameDecoderError

fn from(val: ReadFrameHeaderError) -> Self

Converts to this type from the input type.