Enum Error 

#[non_exhaustive]
pub enum Error {
    Truncated,
    BadMagic,
    Reserved,
    WindowTooLarge,
    MissingDictionary,
    WrongDictionary,
    OutputLimit,
    Checksum,
    ContentSize,
    Corrupt(&'static str),
    BadDictionary(&'static str),
    Parameter(&'static str),
}

What went wrong. Decoding never panics on malformed input; it returns one of these.

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

The input ended before a complete structure could be read.

BadMagic

The input does not start with a zstd or skippable frame magic number.

Reserved

A reserved bit or field was set.

WindowTooLarge

The frame’s window is larger than the decoder accepts.

MissingDictionary

The frame requires a dictionary but none was supplied.

WrongDictionary

The frame names a dictionary ID different from the supplied dictionary’s.

OutputLimit

Decoding would exceed the caller’s output limit (decompression-bomb guard).

Checksum

The frame’s XXH64 checksum does not match the decoded content.

ContentSize

The decoded size disagrees with the frame’s declared content size.

Corrupt(&'static str)

The compressed data is internally inconsistent; the reason is static text.

BadDictionary(&'static str)

A dictionary could not be parsed.

Parameter(&'static str)

A caller-supplied parameter is out of range; the reason is static text.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 PartialEq for Error

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Error