Struct libdeflater::Compressor

pub struct Compressor { /* fields omitted */ }

A libdeflate compressor that can compress arbitrary data into DEFLATE, zlib, or gzip formats.

Implementations

impl Compressor

pub fn new(lvl: CompressionLvl) -> Compressor

Returns a newly constructed Compressor that compresses data with the supplied CompressionLvl

pub fn deflate_compress_bound(&mut self, n_bytes: usize) -> usize

Returns the maximum number of bytes required to encode n_bytes as deflate data. This is a hard upper-bound that assumes the worst possible compression ratio (i.e. assumes the data cannot be compressed), format overhead, etc.

pub fn deflate_compress(
    &mut self,
    in_raw_data: &[u8],
    out_deflate_data: &mut [u8]
) -> Result<usize, CompressionError>

Compresses in_raw_data as deflate data, writing the data into out_deflate_data. Returns the number of bytes written into out_deflate_data.

pub fn zlib_compress_bound(&mut self, n_bytes: usize) -> usize

Returns the maximum number of bytes required to encode n_bytes as zlib data. This is a hard upper-bound that assumes the worst possible compression ratio (i.e. assumes the data cannot be compressed), format overhead, etc.

pub fn zlib_compress(
    &mut self,
    in_raw_data: &[u8],
    out_zlib_data: &mut [u8]
) -> Result<usize, CompressionError>

Compresses in_raw_data as zlib data, writing the data into out_zlib_data. Returns the number of bytes written into out_zlib_data.

pub fn gzip_compress_bound(&mut self, n_bytes: usize) -> usize

Returns the maximum number of bytes required to encode n_bytes as gzip data. This is a hard upper-bound that assumes the worst possible compression ratio (i.e. assumes the data cannot be compressed), format overhead, etc.

pub fn gzip_compress(
    &mut self,
    in_raw_data: &[u8],
    out_gzip_data: &mut [u8]
) -> Result<usize, CompressionError>

Compresses in_raw_data as gzip data, writing the data into out_gzip_data. Returns the number of bytes written into out_gzip_data.

Trait Implementations

impl Drop for Compressor

fn drop(&mut self)

Executes the destructor for this type.