Struct ZlibEncoder

pub struct ZlibEncoder<W: Write> { /* private fields */ }

A Zlib encoder powered by the Zopfli algorithm, that compresses data using a DeflateEncoder. Most users will find using compress easier and more performant.

The caveats about short writes in DeflateEncoders carry over to ZlibEncoders: for best performance and compression, it is best to avoid them. One way to ensure this is to use the new_buffered method.

Implementations

impl<W: Write> ZlibEncoder<W>

pub fn new(options: Options, btype: BlockType, sink: W) -> Result<Self, Error>

Creates a new Zlib encoder that will operate according to the specified options.

pub fn new_buffered( options: Options, btype: BlockType, sink: W, ) -> Result<BufWriter<Self>, Error>

Creates a new Zlib encoder that operates according to the specified options and is wrapped with a buffer to guarantee that data is compressed in large chunks, which is necessary for decent performance and good compression ratio.

pub fn finish(self) -> Result<W, Error>

Encodes any pending chunks of data and writes them to the sink, consuming the encoder and returning the wrapped sink. The sink will have received a complete Zlib stream when this method returns.

The encoder is automatically finished when dropped, but explicitly finishing it with this method allows handling I/O errors.

Trait Implementations

impl<W: Write> Drop for ZlibEncoder<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write> Write for ZlibEncoder<W>

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

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

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

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

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

Attempts to write an entire buffer into this writer.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<W: Write> Write for ZlibEncoder<W>

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

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

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

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

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

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

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.