⚡

Pure Native Zig (0.17.0)

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

🚀

High-Throughput Byte-Oriented Codec

Optimized LZ77 byte-tag encoder and decoder achieving gigabytes-per-second decompression speed and hundreds of MB/s compression.

📦

Official Framed & Raw Block Formats

Full interoperability with Google's Snappy specifications, supporting raw blocks and framed streams (`.sz`) with stream IDs and chunk headers.

🛡️

Memory-Safe & Defensive

Strict bounds checking, safe handling of malformed and truncated inputs, and protection against integer overflow attacks.

🌊

Streaming & I/O Pipelines

First-class integration with Zig 0.17 `std.Io.Reader` and `std.Io.Writer` alongside chunked streaming and file processing.

🔄

Context Reuse & Zero Allocation

Reusable `Compressor` and `Decompressor` instances eliminate heap allocation churn; caller-buffer APIs (`compressInto`, `decompressInto`) require zero heap allocations.

Installation

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

bash

# 1. Stable Release (Tagged)
zig fetch --save https://github.com/muhammad-fiaz/snappy.zig/archive/refs/tags/0.0.1.tar.gz

# 2. Nightly / Latest Development URL
zig fetch --save git+https://github.com/muhammad-fiaz/snappy.zig.git

Then expose the module in your build.zig:

zig

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

Quick Example

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

zig

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

pub fn main() !void {
    const allocator = std.heap.page_allocator;

    const raw_data = "Snappy is a compression/decompression library aimed at very high speeds!";

    // One-shot framed compression (standard .sz stream format)
    const compressed = try snappy.compress(allocator, raw_data);
    defer allocator.free(compressed);

    // One-shot decompression (handles framed streams and raw blocks automatically)
    const restored = try snappy.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});
}

snappy.zigUltra-Fast Native Snappy Compression for Zig