Skip to content
nijaruPublic

About

Rust Brotli implementation from the spec; decoder and partial encoder, still in validation.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

452 Commits

Folders and files

Repository files navigation

brutli

A from-scratch Brotli implementation in Rust, targeting RFC 7932.

Status: the decoder is functional and the encoder supports qualities 0..=11 with compressed and stored streams. The encoder is still under compatibility and corpus validation. Brutli is not ready for production use, does not implement RFC 9841, and does not aim for API compatibility with rust-brotli.

Install

The crate is not published. Depend on the Git repository (or a local path):

[dependencies]
brutli = { git = "https://github.com/nijaru/brutli" }

Decoding

The one-shot API requires a maximum decoded size and rejects trailing bytes after the Brotli stream:

let compressed = brutli::compress(b"Brotli data");
let decoded = brutli::decompress(&compressed, 16 * 1024 * 1024)?;

For incremental decoding, Decoder exposes output/window limits and explicit process / finish calls:

use brutli::Decoder;

let mut decoder = Decoder::with_limits(Some(16 * 1024 * 1024), 22);
let mut output = [0_u8; 8192];
let progress = decoder.process(&compressed, &mut output)?;

Decoder::with_output_limit and Decoder::with_max_window_bits configure one limit at a time. The window limit is checked before history growth. Decode errors are terminal; create a new decoder for another stream.

DecoderReader<R> implements std::io::Read for R: BufRead. It stops at the end of the first Brotli stream and preserves buffered trailing bytes:

use std::io::{Cursor, Read};

let decoder = brutli::Decoder::with_output_limit(16 * 1024 * 1024);
let mut reader = brutli::DecoderReader::with_decoder(Cursor::new(&compressed), decoder);
let mut decoded = Vec::new();
reader.read_to_end(&mut decoded)?;

Decoder::new and DecoderReader::new leave decoded output unbounded. Use a configured decoder for untrusted input.

Encoding

The default one-shot encoder uses quality 5 and WBITS=22:

let compressed = brutli::compress(b"Brotli data");
let compressed = brutli::compress_with_quality(b"Brotli data", 9)?;

compress_with_options accepts EncoderOptions:

use brutli::{EncoderMode, EncoderOptions, compress_with_options};

let compressed = compress_with_options(
    b"Brotli data",
    EncoderOptions {
        quality: 9,
        window_bits: 22,
        mode: EncoderMode::Generic,
    },
)?;

For streaming, Encoder provides process and finish with the same bounded-output model as Decoder. EncoderOptions validates quality and window bits (10..=24).

Quality levels 10 and 11 do not yet use Zopfli-style optimal parsing. EncoderMode::Font selects Brotli's font distance parameters; other modes currently share the generic encoder path.

Validation

cargo test --all-features
cargo clippy --all-targets --all-features -- -D warnings

The test suite includes reference differential tests, malformed and truncated input cases, history-window wrap tests, and encoder interoperability checks. A C CLI round-trip test runs when the brotli executable is installed; CI installs it. Fuzz targets for decoding and encoder round trips are in fuzz/.

Benchmarks

Decoder and encoder benchmarks compare Brutli with rust-brotli by default:

cargo bench --bench decode
cargo bench --bench encode

Enable current-google-reference to add the pinned Google Brotli C implementation. That feature requires linking a local Google Brotli build; the benchmark workflow builds the pinned commit automatically. On Linux, scripts/profile-decode.sh profiles the decoder, with an optional Google comparator via GOOGLE_BROTLI_BUILD.

License

MIT

About

Rust Brotli implementation from the spec; decoder and partial encoder, still in validation.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages