compress-lib 0.3.0

Scope

Raw DEFLATE inflate and deflate with window bits 8 to 15 and levels 0 to 9; sync, full, and finish flushes; zlib and gzip framing with checksums always verified; preset dictionaries; per-message compression for WebSocket servers and clients (context takeover on or off); CRC-32 and Adler-32; std::io adapters. Brotli follows after 1.0. It does not negotiate HTTP or WebSocket headers (http-net and ws-net do) and it does not read archives.

Quick start

[dependencies]
compress = { package = "compress-lib", version = "0.3" }

Available now:

let data = compress::deflate::decompress(&raw)?;      // raw DEFLATE, capped at 64 MiB
let crc = compress::checksum::crc32(&data);           // gzip's checksum

Streaming, with buffers you own:

use compress::deflate::{Inflater, Status};

let mut inflater = Inflater::new();                    // window 15, default limits
let p = inflater.decompress(input, &mut output)?;     // push input, pull output
match p.status {
    Status::NeedsInput => { /* feed input[p.consumed..] and more */ }
    Status::NeedsOutput => { /* drain output[..p.produced], call again */ }
    _ => { /* Status::Done: the stream ended at input[p.consumed] */ }
}

Planned (0.4 and 0.5), the same shape for every codec:

let packed = compress::gzip::compress(body);          // Vec<u8>, level 6
let body = compress::gzip::decompress(&packed)?;      // capped at 64 MiB by default

The complete planned API, with the version each item arrives in, is in docs/API.md.

Contributing

See dev/DIRECTIVES.md for engineering standards and the definition of done. Before a PR: cargo fmt --all, cargo clippy --all-targets --all-features -- -D warnings, and cargo test --all-features must be clean.