Struct lzxd::Lzxd

pub struct Lzxd { /* private fields */ }

The main interface to perform LZXD decompression.

This structure stores the required state to process the compressed chunks of data in a sequential order.

use ::lzxd::{Lzxd, WindowSize};

let mut lzxd = Lzxd::new(WindowSize::KB64);

while let Some((chunk, output_size)) = get_compressed_chunk() {
    let decompressed = lzxd.decompress_next(&chunk, output_size);
    write_data(decompressed.unwrap());
}

Implementations

impl Lzxd

pub fn new(window_size: WindowSize) -> Self

Creates a new instance of the LZXD decoder state. The WindowSize must be obtained from elsewhere (e.g. it may be predetermined to a certain value), and if it’s wrong, the decompressed values won’t be those expected.

pub fn decompress_next( &mut self, chunk: &[u8], output_len: usize ) -> Result<&[u8], DecompressError>

Decompresses the next compressed chunk from the LZXD data stream.

pub fn reset(&mut self)

Resets the decoder state.

This is equivalent to calling Self::new with the same WindowSize. WindowSize: enum.WindowSize.html