StreamingCompressor

Chunk-based compression facade over Encoder. Feed input chunks with process, drain compressed bytes from the returned slices, then finish. Defined in src/compress/encode.zig, re-exported as brotli.StreamingCompressor.

Creation

pub fn init(allocator: std.mem.Allocator, options: CompressionOptions) StreamingCompressor

var sc = brotli.StreamingCompressor.init(allocator, .{ .quality = 9 });
defer sc.deinit();

Feeding Input

pub fn process(self: *StreamingCompressor, chunk: []const u8) ![]u8

Returns freshly allocated compressed bytes (caller frees). Empty slice when the encoder has not yet produced output.

Flush / Finish

pub fn flush(self: *StreamingCompressor) ![]u8   // force all pending blocks
pub fn finish(self: *StreamingCompressor) ![]u8  // emit final block; stream done
pub fn isFinished(self: *const StreamingCompressor) bool

Extras

pub fn setProgress(self: *StreamingCompressor, cb: ?ProgressCallback, ctx: ?*anyopaque) void
pub fn attachDictionary(self: *StreamingCompressor, data: []const u8) bool

Example

var sc = brotli.StreamingCompressor.init(allocator, .{ .quality = 11 });
defer sc.deinit();

var out = std.ArrayList(u8).empty;
defer out.deinit(allocator);

for (chunks) |chunk| {
    const piece = try sc.process(chunk);
    defer allocator.free(piece);
    try out.appendSlice(allocator, piece);
}
const tail = try sc.finish();
defer allocator.free(tail);
try out.appendSlice(allocator, tail);