Struct DictionaryRefused 

pub struct DictionaryRefused<READ, DEC = ()> { /* private fields */ }

A dictionary a StreamingDecoder constructor refused, with what the constructor took by value handed back: the source, unread, since the dictionary is checked before anything is read, and the decoder where the caller passed one (() where the constructor makes its own).

Debug and Display show the decoder’s error as it is, so an unwrap or a message reads the same as for a FrameDecoderError.

Examples

use structured_zstd::decoding::StreamingDecoder;

let archive_entry: &[u8] = b"\x28\xb5\x2f\xfd...";
// The dictionary magic with nothing after it.
let blob = 0xEC30_A437u32.to_le_bytes();
let refused = StreamingDecoder::new_with_dictionary_bytes(archive_entry, &blob)
    .err()
    .expect("a truncated dictionary is refused");
eprintln!("dictionary refused: {refused}");
// The entry is still the caller's, as it was handed over.
assert_eq!(refused.into_source(), archive_entry);

Implementations

impl<READ, DEC> DictionaryRefused<READ, DEC>

pub fn error(&self) -> &FrameDecoderError

Why the dictionary was refused.

pub fn into_source(self) -> READ

The source, as the constructor was given it.

pub fn into_parts(self) -> (READ, DEC, FrameDecoderError)

The source, the decoder and the error.

Trait Implementations

impl<READ, DEC> Debug for DictionaryRefused<READ, DEC>

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

Formats the value using the given formatter.

impl<READ, DEC> Display for DictionaryRefused<READ, DEC>

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

Formats the value using the given formatter.

impl<READ, DEC> Error for DictionaryRefused<READ, DEC>

Available on crate feature std only.

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.