⚡

Pure Native Zig (0.17.0)

Engineered from first principles in native Zig without `@cImport`, C compiler requirements, or external runtime dependencies.

🚀

Blazing Fast & High Compression

Features both the standard Fast match-finder with configurable acceleration and the optimal High-Compression (HC) engine (levels 2..12).

📦

Frame & Block Standard Formats

Full interoperability with reference LZ4 tooling (v1.5.1 Block and v1.6.4 Frame specs), handling block headers, checksums, and skippable frames.

🛡️

Memory-Safe & Bounded

Robust error handling, protection against decompression bombs with `maxOutputSize`, and decoder robustness verified with continuous fuzzing.

🌊

Streaming & I/O Pipelines

First-class integration with Zig 0.17 `std.Io.Reader` and `std.Io.Writer` alongside push/pull stateful chunked streaming.

📚

Dictionaries & Context Reuse

Reusable `Compressor` and `Decompressor` instances eliminate allocation churn; attach pre-shared dictionaries for compressing small structured payloads.

Installation

Add lz4.zig to your build.zig.zon:

bash

# Stable Release
zig fetch --save https://github.com/muhammad-fiaz/lz4.zig/archive/refs/tags/0.0.1.tar.gz

# Latest / Dev / Nightly
zig fetch --save git+https://github.com/muhammad-fiaz/lz4.zig.git

Then expose the module in your build.zig:

zig

const lz4_dep = b.dependency("lz4", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("lz4", lz4_dep.module("lz4"));

Quick Example

Compress and decompress data in just a few lines of idiomatic Zig:

zig

const std = @import("std");
const lz4 = @import("lz4");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const allocator = gpa.allocator();

    const raw_data = "LZ4 is an extremely fast lossless compression algorithm!";

    // One-shot compression to a standard LZ4 frame
    const compressed = try lz4.compress(allocator, raw_data);
    defer allocator.free(compressed);

    // One-shot decompression (handles frames and blocks automatically)
    const restored = try lz4.decompress(allocator, compressed);
    defer allocator.free(restored);

    std.debug.print("Original size:   {d} bytes\n", .{raw_data.len});
    std.debug.print("Compressed size: {d} bytes\n", .{compressed.len});
    std.debug.print("Restored:        {s}\n", .{restored});
}

lz4.zigUltra-Fast Native LZ4 Compression for Zig