Struct Encoder 

pub struct Encoder(/* private fields */);

A streaming encoder for any Format.

Examples

use compress_lib::{Encoder, Format, Level, deflate::Flush, gzip};

let mut enc = Encoder::new(Format::Gzip, Level::DEFAULT);
let mut out = Vec::new();
enc.compress_vec(b"response body", &mut out, Flush::Finish)?;
assert_eq!(gzip::decompress(&out)?, b"response body");

Implementations

impl Encoder

pub fn new(format: Format, level: Level) -> Self

An encoder for format at level.

Examples

use compress_lib::{Encoder, Format, Level};

assert_eq!(Encoder::new(Format::Zlib, Level::FAST).format(), Format::Zlib);

pub fn format(&self) -> Format

The format written.

Examples

use compress_lib::{Encoder, Format, Level};

assert_eq!(Encoder::new(Format::Raw, Level::FAST).format(), Format::Raw);

pub fn compress( &mut self, input: &[u8], output: &mut [u8], flush: Flush, ) -> Result<Progress, Error>

As Deflater::compress, with the format’s header and trailer.

Errors

As Deflater::compress.

Examples

use compress_lib::{Encoder, Format, Level, deflate::{Flush, Status}};

let mut enc = Encoder::new(Format::Zlib, Level::DEFAULT);
let mut out = [0u8; 64];
assert_eq!(enc.compress(b"abc", &mut out, Flush::Finish)?.status, Status::Done);

pub fn compress_vec( &mut self, input: &[u8], out: &mut Vec<u8>, flush: Flush, ) -> Result<Progress, Error>

As Deflater::compress_vec.

Errors

As compress, plus AllocationFailed.

Examples

use compress_lib::{Encoder, Format, Level, deflate::Flush, zlib};

let mut out = Vec::new();
Encoder::new(Format::Zlib, Level::DEFAULT).compress_vec(b"abc", &mut out, Flush::Finish)?;
assert_eq!(zlib::decompress(&out)?, b"abc");

pub fn reset(&mut self)

Starts a new stream, keeping allocations.

Examples

let mut enc = compress_lib::Encoder::new(compress_lib::Format::Gzip, compress_lib::Level::FAST);
enc.reset();

Trait Implementations

impl Debug for Encoder

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

Formats the value using the given formatter.