Zig

Add Custom Extra Data to a Gzip File

This example demonstrates how to use the SetExtraData method to include custom binary data in the Gzip header using a hex-encoded string.

The hex string represents the raw bytes to embed in the Gzip metadata. When a compression method is called, this data is included in the Gzip header.

The example also shows how to retrieve the metadata using GetGzipInfo to verify that the extra data was successfully embedded. The retrieved value is returned as a Base64-encoded string.

Zig

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

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // This example demonstrates how to include custom extra data
    // in the Gzip header when compressing.

    // The extra data is provided as a hex-encoded string.

    const gzip = try chilkat.Gzip.init();
    defer gzip.deinit();
    const json = try chilkat.JsonObject.init();
    defer json.deinit();

    // Set extra data using a hex string.
    // This example represents 4 bytes: 00 01 02 03
    gzip.setExtraData("00010203", "hex") catch {
        std.debug.print("{s}\n", .{try gzip.getLastErrorText(alloc)});
        return;
    };

    // Compress a file so the extra data is embedded in the Gzip header:
    const input_file = "example.txt";
    const output_file = "example.txt.gz";

    gzip.compressFile(input_file, output_file) catch {
        std.debug.print("{s}\n", .{try gzip.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Gzip file created with extra data.\n", .{});

    // (Optional) Retrieve the metadata to verify:
    gzip.getGzipInfo(output_file, json) catch {
        std.debug.print("{s}\n", .{try gzip.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Metadata JSON:\n", .{});
    std.debug.print("{s}\n", .{try json.emit(alloc)});
}