Struct Decoder 

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

A streaming decoder for any Format.

Examples

use compress_lib::{Decoder, Format, gzip};

let mut dec = Decoder::new(Format::Gzip);
let mut out = Vec::new();
dec.finish_vec(&gzip::compress(b"any format"), &mut out)?;
assert_eq!(out, b"any format");

Implementations

impl Decoder

pub fn new(format: Format) -> Self

A decoder for format with the default limits.

Examples

let dec = compress_lib::Decoder::new(compress_lib::Format::Zlib);
assert_eq!(dec.format(), compress_lib::Format::Zlib);

pub fn with_limits(self, limits: Limits) -> Self

Sets the limits checked while decoding.

Examples

use compress_lib::{Decoder, Format, Limits};

let dec = Decoder::new(Format::Gzip).with_limits(Limits::new().with_max_output(1 << 20));

pub fn format(&self) -> Format

The format decoded.

Examples

use compress_lib::{Decoder, Format};

assert_eq!(Decoder::new(Format::Raw).format(), Format::Raw);

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

As Inflater::decompress.

Errors

The errors of the format’s decoder.

Examples

use compress_lib::{Decoder, Format, deflate::Status, zlib};

let mut out = [0u8; 16];
let p = Decoder::new(Format::Zlib).decompress(&zlib::compress(b"abc"), &mut out)?;
assert_eq!(p.status, Status::Done);

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

As Inflater::finish.

Errors

The errors of the format’s decoder, plus UnexpectedEnd.

Examples

use compress_lib::{Decoder, Format, gzip};

let mut out = [0u8; 16];
let p = Decoder::new(Format::Gzip).finish(&gzip::compress(b"abc"), &mut out)?;
assert_eq!(&out[..p.produced], b"abc");

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

As Inflater::decompress_vec.

Errors

The errors of the format’s decoder, plus AllocationFailed.

Examples

use compress_lib::{Decoder, Format, deflate};

let mut out = Vec::new();
Decoder::new(Format::Raw).decompress_vec(&deflate::compress(b"raw"), &mut out)?;
assert_eq!(out, b"raw");

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

As Inflater::finish_vec.

Errors

The errors of the format’s decoder, plus UnexpectedEnd and AllocationFailed.

Examples

use compress_lib::{Decoder, Format, zlib};

let mut out = Vec::new();
Decoder::new(Format::Zlib).finish_vec(&zlib::compress(b"z"), &mut out)?;
assert_eq!(out, b"z");

pub fn is_done(&self) -> bool

true once the stream ended.

Examples

assert!(!compress_lib::Decoder::new(compress_lib::Format::Gzip).is_done());

pub fn total_in(&self) -> u64

Compressed bytes consumed.

Examples

assert_eq!(compress_lib::Decoder::new(compress_lib::Format::Gzip).total_in(), 0);

pub fn total_out(&self) -> u64

Decompressed bytes produced.

Examples

assert_eq!(compress_lib::Decoder::new(compress_lib::Format::Gzip).total_out(), 0);

pub fn reset(&mut self)

Starts over for a new stream, keeping allocations.

Examples

let mut dec = compress_lib::Decoder::new(compress_lib::Format::Zlib);
dec.reset();

Trait Implementations

impl Debug for Decoder

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

Formats the value using the given formatter.