Struct compu::compressor::write::Compressor

pub struct Compressor<E, W> where
    E: Encoder,
    W: Write,  { /* fields omitted */ }

Compressor

It writes compressed data to supplied writer that implements Write You can finish compression, by calling push with op equal to EncoderOp::Finish

Usage

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

let data = vec![5; 5];
let mut encoder = compu::compressor::write::Compressor::new(BrotliEncoder::default(), Vec::new());
let result = encoder.push(&data, EncoderOp::Finish).expect("Successful compression");
assert!(result > 0);
assert!(encoder.encoder().is_finished());

Methods

impl<E: Encoder, W: Write> Compressor<E, W>

pub fn new(encoder: E, writer: W) -> Self

Creates new instance

pub fn encoder(&self) -> &E

Returns reference to underlying encoder

pub fn writer(&self) -> &W

Returns reference to underlying writer

pub fn writer_mut(&mut self) -> &mut W

Returns mutable reference to underlying writer

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

Pushes chunk to compressor

Specify op equal to EncoderOp::Finish when last chunk is being pushed. Allowed to be empty chunk.

Returns number of bytes written.

Returns io::Error if underlying writer fails, note that if io::Error happens then compressed data will be lost

Returns io::ErrorKind::InvalidData if compression fails.

Important traits for AutoFinish<E, W>

impl<E: Encoder, W: Write> Write for AutoFinish<E, W>

pub fn auto_finish(self) -> AutoFinish<E, W>

Enables automatic finish for compressor.

pub fn take(self) -> W

Consumes self and returns underlying writer.

Trait Implementations

impl<E: Encoder, W: Write> Write for Compressor<E, W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.