Struct Compressor 

pub struct Compressor { /* private fields */ }

A reusable block compressor that owns its dictionary.

This is the ergonomic API for use with alloc. For a no-alloc variant that borrows the dictionary, see CompressorRef.

For one-shot compression, use compress or compress_into instead.

Example

use lz4rip_encode::{Compressor, get_maximum_output_size};

let mut comp = Compressor::new();
let input = b"hello world, hello world, hello!";
let mut output = vec![0u8; get_maximum_output_size(input.len())];
let compressed_len = comp.compress_into(input, &mut output).unwrap();

Implementations

impl Compressor

pub fn new() -> Self

Create a new compressor without a dictionary.

pub fn with_dict(dict: &[u8]) -> Self

Create a new compressor seeded with an external dictionary.

The dictionary is cloned into owned storage. If dict is shorter than 4 bytes, it is ignored.

pub fn compress_into( &mut self, input: &[u8], output: &mut [u8], ) -> Result<usize, CompressError>

Compress input into output, returning the number of compressed bytes.

output must be at least [get_maximum_output_size](input.len()) bytes.

pub fn compress(&mut self, input: &[u8]) -> Vec<u8>

Compress input into a new Vec<u8>.

Trait Implementations

impl Debug for Compressor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Compressor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Compressor

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.