Struct DecodeOptions 

pub struct DecodeOptions<'d> { /* private fields */ }

Configurable decompression: an output-size limit, a maximum accepted window log, and an optional dictionary.

use libzstd_bitexact_rs::DecodeOptions;
let frame = [0x28, 0xB5, 0x2F, 0xFD, 0x20, 0x05, 0x2B, 0x00, 0x00, b'a'];
let out = DecodeOptions::new().limit(1 << 20).decompress(&frame).unwrap();
assert_eq!(out, b"aaaaa");

Implementations

impl<'d> DecodeOptions<'d>

pub fn new() -> Self

Default options: no output limit, window log up to WINDOW_LOG_MAX, no dictionary.

pub fn limit(self, limit: usize) -> Self

Fail with Error::OutputTooLarge once the output would exceed limit bytes. Use this on untrusted input to defuse decompression bombs.

pub fn window_log_max(self, window_log_max: u32) -> Self

Reject frames whose declared window log exceeds window_log_max (ZSTD_d_windowLogMax). Values above WINDOW_LOG_MAX are treated as WINDOW_LOG_MAX.

pub fn dictionary(self, dictionary: &'d Dictionary) -> Self

Decode using dictionary as window history and entropy-table seed (ZSTD_decompress_usingDict). The dictionary applies to every frame in the input.

pub fn decompress(&self, src: &[u8]) -> Result<Vec<u8>, Error>

Decompress a sequence of frames with these options.

Trait Implementations

impl<'d> Clone for DecodeOptions<'d>

fn clone(&self) -> DecodeOptions<'d>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DecodeOptions<'_>

fn default() -> Self

Returns the “default value” for a type.