Struct DecompressContext 

pub struct DecompressContext { /* private fields */ }

Reusable decompression context that amortizes buffer allocations.

Holds internal buffers (output, Huffman/FSE workspace) across calls. Useful when decompressing many small frames in a loop.

let data = b"repeated decompression".repeat(100);
let compressed = zrip::compress(&data, 1).unwrap();

let mut ctx = zrip::DecompressContext::new();
for _ in 0..10 {
    let output = ctx.decompress(&compressed).unwrap();
    assert_eq!(&*output, &data[..]);
}

Implementations

impl DecompressContext

pub fn new() -> Self

Creates a new context without a dictionary.

pub fn with_dict(dict: Dictionary) -> Self

Creates a new context with a pre-loaded dictionary.

pub fn decompress( &mut self, input: &[u8], ) -> Result<Cow<'_, [u8]>, DecompressError>

Decompresses input using DEFAULT_DECOMPRESS_LIMIT.

pub fn decompress_with_limit( &mut self, input: &[u8], max_output: usize, ) -> Result<Cow<'_, [u8]>, DecompressError>

Decompresses input with an explicit output size limit.

Returns DecompressError::OutputTooSmall if the decompressed output would exceed max_output bytes.

pub fn decompress_after_magic_with_limit( &mut self, input: &[u8], max_output: usize, ) -> Result<Cow<'_, [u8]>, DecompressError>

Decompresses one zstd frame whose 4-byte magic number is stored out of band.

OpenZL stores zstd payloads this way inside transform streams.

pub fn decompress_after_magic_into( &mut self, input: &[u8], output: &mut Vec<u8>, max_output: usize, ) -> Result<usize, DecompressError>

Decompresses one zstd frame without its magic number into output.

Appends to output and returns the number of bytes written.

Trait Implementations

impl Default for DecompressContext

fn default() -> Self

Returns the “default value” for a type.