Struct lzss::LzssDyn

pub struct LzssDyn { /* private fields */ }

Dynamic parameters for de-/compression (see Lzss for compile-time parameters).

Parameters

• ei - The number of bits in the offset, usually 10..13
• ej - The number of bits in the length, usually 4..5
• c - The initial fill byte of the buffer, usually 0x20 (space)

Restrictions

• ej must be larger than 0
• ei must be larger than ej
• ei + ej must be at least 8
• ei + ej must be 24 or less

Example

let my_lzss = LzssDyn::new(10, 4, 0x20)?;
let input = b"Example Data";
let result = my_lzss.compress(
  SliceReader::new(input),
  VecWriter::with_capacity(30),
);
assert_eq!(result.void_unwrap().len(), 14); // the output is 14 bytes long

Implementations

impl LzssDyn

pub fn new(ei: usize, ej: usize, c: u8) -> Result<Self, LzssDynError>

Create new Lzss parameters.

If the parameter are not valid (see above) an error is returned.

For creating a const see Lzss::as_dyn.

pub const fn ei(&self) -> usize

Get the ei parameter.

pub const fn ej(&self) -> usize

Get the ej parameter.

pub const fn c(&self) -> u8

Get the c parameter.

pub fn compress<R: Read, W: Write>( &self, reader: R, writer: W ) -> Result<W::Output, LzssError<R::Error, W::Error>>

Available on crate features alloc or std only.

Compress the input data into the output.

The buffer, with 2 * (1 << EI) bytes, is allocated on the heap.

pub fn compress_with_buffer<R: Read, W: Write>( &self, reader: R, writer: W, buffer: &mut [u8] ) -> Result<W::Output, LzssError<R::Error, W::Error>>

Compress the input data into the output.

It will be asserted at runtime that the buffer is at least 2 * (1 << EI).

pub fn decompress<R: Read, W: Write>( &self, reader: R, writer: W ) -> Result<W::Output, LzssError<R::Error, W::Error>>

Available on crate features alloc or std only.

Decompress the input data into the output.

The buffer, with 1 << EI bytes, is allocated on the heap.

pub fn decompress_with_buffer<R: Read, W: Write>( &self, reader: R, writer: W, buffer: &mut [u8] ) -> Result<W::Output, LzssError<R::Error, W::Error>>

Decompress the input data into the output.

It will be asserted at runtime that the buffer is at least 1 << EI.

Trait Implementations

impl Clone for LzssDyn

fn clone(&self) -> LzssDyn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<LzssDyn> for LzssDyn

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for LzssDyn

impl Eq for LzssDyn

impl StructuralEq for LzssDyn

impl StructuralPartialEq for LzssDyn