Enum CompressionEncoder

pub enum CompressionEncoder<'a> {
    Bzip2(BzEncoder<File>),
    Gzip(GzEncoder<File>),
    Xz(XzEncoder<File>),
    Zstd(Encoder<'a, File>),
}

Encoder for compression which supports multiple backends.

Wraps BzEncoder, GzEncoder, XzEncoder and [Encoder]. Provides a unified Write implementation across all of them.

Variants

Bzip2(BzEncoder<File>)

The bzip2 compression encoder.

Gzip(GzEncoder<File>)

The gzip compression encoder.

Xz(XzEncoder<File>)

The xz compression encoder.

Zstd(Encoder<'a, File>)

The zstd compression encoder.

Implementations

impl CompressionEncoder<'_>

pub fn new(file: File, settings: &CompressionSettings) -> Result<Self, Error>

Creates a new CompressionEncoder.

Uses a File to stream to and initializes a specific backend based on the provided CompressionSettings.

Errors

Returns an error if creating the encoder for zstd compression fails. All other encoder initializations are infallible.

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

Finishes the compression stream.

Error

Returns an error if the wrapped encoder fails.

Trait Implementations

impl Debug for CompressionEncoder<'_>

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

Formats the value using the given formatter.

impl Write for CompressionEncoder<'_>

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

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

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

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

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

Flushes 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_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

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.

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_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.