API Reference

One-Shot Functions

compress

pub fn compress(allocator: std.mem.Allocator, input: []const u8) ![]u8

One-shot compression with default options (quality 11, window 22).

compressWithOptions

pub fn compressWithOptions(
    allocator: std.mem.Allocator,
    input: []const u8,
    options: CompressionOptions,
) ![]u8

Full control: quality (0–11), lgwin (10–24), mode, size hint, progress callback. See CompressionOptions.

decompress

pub fn decompress(allocator: std.mem.Allocator, input: []const u8) ![]u8

One-shot decompression into a freshly allocated buffer.

decompressWithOptions

pub fn decompressWithOptions(allocator, input, options: DecoderOptions) ![]u8

Decoder options include large_window for LGWIN up to 30.

decompressInto

pub fn decompressInto(allocator, input: []const u8, output: []u8) !usize

Decompress into a caller-provided buffer; returns bytes written.

maxCompressedSize

pub fn maxCompressedSize(input_size: usize) usize

Upper bound for output allocation (mirrors BrotliEncoderMaxCompressedSize).

Types

Type	Definition	Docs
Encoder	src/compress/encode.zig	Encoder
Decoder	src/decompress/decode.zig	Decoder
StreamingCompressor	src/compress/encode.zig	StreamCompressor
StreamingDecompressor	src/brotli.zig	StreamDecompressor
CompressionOptions	src/compress/encode.zig	Options
DecoderOptions	src/decompress/decode.zig	Options
Dictionaries	src/dictionary/dictionary.zig + attach APIs	Dict
ErrorCode / DecodeResult	src/decompress/decode.zig	Errors

Version

brotli.version        // "0.0.2"
brotli.versionNumber() // 2
brotli.versionString() // "0.0.2"

Constants

Quality/window bounds and format sizes — see Constants.