Struct Decoder

pub struct Decoder(/* private fields */);

A decoder for decompressing data.

Implementations

impl Decoder

pub fn new(params: DParams) -> Result<Self, Error>

Create a new Decoder with the given decompression parameters.

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

Decompress the given bytes into a new allocated Vec<u8>.

Note that the returned vector may not be aligned to the original data type’s alignment, and the caller should ensure that the alignment is correct before transmuting it to original type. If the alignment does not match the original data type, the bytes should be copied to a new aligned allocation before transmuting, otherwise undefined behavior may occur. Alternatively, the caller can use Self::decompress_into and provide an already aligned destination buffer.

pub fn decompress_into( &mut self, src: &[u8], dst: &mut [MaybeUninit<u8>], ) -> Result<usize, Error>

Decompress the given bytes into a pre-allocated buffer.

pub fn params(&self) -> DParams

Get the decompression parameters used by this decoder.