Crate compress_lib 

compress_lib

DEFLATE (RFC 1951), zlib (RFC 1950), and gzip (RFC 1952) for Rust services, with the per-message rules of WebSocket permessage-deflate (RFC 7692).

The engine is sans-IO: the caller pushes input and pulls output through buffers it owns. Memory is fixed when an engine is built and never grows with input, and every decoder enforces an absolute output cap while it decodes, so a decompression bomb costs at most the cap. There is no unsafe code and no third-party runtime dependency.

Tier 1

Add it with Cargo’s rename, compress = { package = "compress-lib", version = "0.3" }, and code reads compress::. One call decompresses a complete raw DEFLATE stream, capped at 64 MiB of output by default:

use compress_lib as compress;

let data = compress::deflate::decompress(&[0xCB, 0x48, 0xCD, 0xC9, 0xC9, 0x07, 0x00])?;
assert_eq!(data, b"hello");

let small = compress::Limits::new().with_max_output(1 << 20);
let data = compress::deflate::decompress_with(&[0x03, 0x00], small)?;
assert!(data.is_empty());

Streaming

deflate::Inflater takes input and output buffers you own and says where it stopped (Status); memory is fixed when it is built (about 11 KiB of tables plus a window of 2^window_bits bytes), and every limit is checked before output is written.

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

let mut inflater = Inflater::new().with_window_bits(12)?;
let mut out = [0u8; 4096];
let p = inflater.finish(&[0xCB, 0x48, 0xCD, 0xC9, 0xC9, 0x07, 0x00], &mut out)?;
assert_eq!(p.status, Status::Done);
assert_eq!(&out[..p.produced], b"hello");

Every failure is an Error with a matchable ErrorKind and a stable code for logs and metrics. checksum has CRC-32 and Adler-32.

Status

0.3.0, the raw DEFLATE inflater. The deflater and the RFC 7692 helpers arrive in 0.4, zlib and gzip in 0.5; the complete planned API, each item with its version, is docs/API.md in the repository.

Modules

checksum

CRC-32 and Adler-32.

deflate

Raw DEFLATE (RFC 1951).

Structs

Error

A codec error: its ErrorKind and the input offset where it was found.

Level

A compression level, 0 to 9, with zlib’s meaning: 0 stores without compressing, 1 is the fastest, 9 compresses best, 6 is the default.

Limits

Caps a decoder enforces while it decodes.

Progress

What one streaming call did.

Enums

ErrorKind

What went wrong, as a stable, matchable value.

Status

Where a streaming engine stopped.

Constants

VERSION

Crate version string, populated by Cargo at build time.