Trait CompressionFormat

pub trait CompressionFormat {
    type Encoder<W: Write>: Write;
    type Decoder<R: Read>: Read;

    // Required methods
    fn encode_writer<W: Write>(&self, writer: W, level: u32) -> Self::Encoder<W>;
    fn decode_reader<R: Read>(&self, reader: R) -> Self::Decoder<R>;
}

Available on crate feature compression only.

Defines a format for lossless compression of arbitrary data.

In order to use a CompressionFormat, you may consider using the Compressed struct.

Required Associated Types

type Encoder<W: Write>: Write

The encoder wrapper type that compresses data sent to the contained writer.

type Decoder<R: Read>: Read

The decoder wrapper type that decompresses data sent from the contained reader.

Required Methods

fn encode_writer<W: Write>(&self, writer: W, level: u32) -> Self::Encoder<W>

Wraps a writer that takes uncompressed data, producing a new writer that outputs compressed data.

fn decode_reader<R: Read>(&self, reader: R) -> Self::Decoder<R>

Wraps a reader that takes compressed data, producing a new reader that outputs uncompressed data.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl CompressionFormat for BZip2

Available on crate feature bzip only.

type Encoder<W: Write> = BzEncoder<W>

type Decoder<R: Read> = BzDecoder<R>

impl CompressionFormat for Deflate

Available on crate feature flate only.

type Encoder<W: Write> = DeflateEncoder<W>

type Decoder<R: Read> = DeflateDecoder<R>

impl CompressionFormat for Gz

Available on crate feature flate only.

type Encoder<W: Write> = GzEncoder<W>

type Decoder<R: Read> = GzDecoder<R>

impl CompressionFormat for ZLib

Available on crate feature flate only.

type Encoder<W: Write> = ZlibEncoder<W>

type Decoder<R: Read> = ZlibDecoder<R>

impl CompressionFormat for Xz

Available on crate feature xz only.

type Encoder<W: Write> = XzEncoder<W>

type Decoder<R: Read> = XzDecoder<R>