Struct compu::compressor::memory::Compressor

pub struct Compressor<E> { /* fields omitted */ }

Compressor

It stores compressed data in its internal buffer. Once last chunk is pushed, by calling push with op equal to EncoderOp::FINISH Result can be retrieved using output or take.

Usage

use compu::encoder::{Encoder, EncoderOp, BrotliEncoder};

let data = vec![5; 5];
let mut encoder = compu::compressor::memory::Compressor::new(BrotliEncoder::default());
let result = encoder.push(&data, EncoderOp::Finish);
assert!(result);
assert!(encoder.encoder().is_finished());

Methods

impl<E: Encoder> Compressor<E>

pub fn new(encoder: E) -> Self

Creates new instance

pub fn with_capacity(capacity: usize, encoder: E) -> Self

Creates new instance with provided capacity

pub fn encoder(&self) -> &E

Returns reference to underlying encoder

pub fn push(&mut self, data: &[u8], op: EncoderOp) -> bool

Pushes chunk to compressor

Specify op as EncoderOp::Finish when last chunk is being pushed

Returns whether operation is successful.

pub fn output<'a>(&'a self) -> &'a [u8]

Returns slice of currently compressed data

pub fn consume_output<'a>(&'a mut self) -> &'a [u8]

Returns slice of currently decompressed data and marks it as consumed

After calling this function, the underlying buffer basically sets length equal to 0 allowing to overwrite already written data with further pushes.

pub fn take(self) -> Vec<u8>

Consumes self and returns underlying data.