⚡

Pure Native Zig (0.17.0)

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

🗜️

Standard XZ Container Format

Implements the official XZ specification with 12-byte stream headers (`FD 37 7A 58 5A 00`), 4-byte block framing, variable-length integers, indexes, and stream footers.

🛡️

Multi-Algorithm Integrity Checks

Complete native support for None, CRC32 (IEEE 802.3), CRC64 (ECMA-182 reversed polynomial), and cryptographic SHA-256 block checksums.

🔗

Composable Filter Chains

Supports primary LZMA2 (`0x21`) via the independent `lzma2.zig` package, plus native Delta (`0x03`) and x86 BCJ branch-call-jump (`0x04`) address translation filters.

🌊

First-Class Streaming I/O

Incremental block-by-block and reader/writer streaming pipelines (`compressStream`, `decompressStream`, `StreamingCompressor`) with bounded memory.

🔄

Zero-Heap Caller Buffers

Stack and caller-provided buffer APIs (`compressInto`, `decompressInto`) operate with zero dynamic heap allocation overhead.

Installation

xz.zig is production-ready. The recommended method for production applications is pinning to the tagged stable release:

bash

# Recommended: Tagged stable release (0.0.1)
zig fetch --save https://github.com/muhammad-fiaz/xz.zig/archive/refs/tags/0.0.1.tar.gz

# Alternative: Latest development build (main branch)
zig fetch --save git+https://github.com/muhammad-fiaz/xz.zig.git

Then expose the module in your build.zig:

zig

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

Quick Example

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

zig

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

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

    const payload = "Native XZ container compression in pure Zig 0.17.0! High-ratio dictionary encoding with CRC64.";

    // One-shot heap compression with standard CRC64 integrity check
    const compressed = try xz.compress(allocator, payload, .{ .check = .crc64 });
    defer allocator.free(compressed);

    // One-shot heap decompression
    const restored = try xz.decompress(allocator, compressed, .{});
    defer allocator.free(restored);

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

xz.zigNative XZ Container Compression for Zig