Struct compu::compressor::write::AutoFinish

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

Wrapper over Compressor that automatically finishes compression if needed.

Note that, finish will happen only if some operation happened, but not EncoderOp::Finish

Note:

There is no buffering involved, as soon as data is ready, it is written. Which means it is not suitable for async IO where WouldBlock error can happen as it is considered a error case due to lack of any buffer

Note:

It relies on fact that any operation after EncoderOp::Finish will fail.

Methods

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

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 underlying compressor.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl<E: Encoder, W: Write> Write for AutoFinish<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.