Getty is a framework for building robust, optimal, and reusable (de)serializers in Zig.
- Compile-time (de)serialization.
- Out-of-the-box support for a variety of
stdtypes. - Granular customization for existing and remote types.
- Data models that serve as simple and generic baselines for (de)serializers.
build.zig
conststd=@import("std");
pubfnbuild(b: *std.Build) void {
consttarget=b.standardTargetOptions(.{});
constoptimize=b.standardOptimizeOption(.{});
constopts= .{ .target=target, .optimize=optimize };
constjson_mod=b.dependency("json", opts).module("json");
constexe=b.addExecutable(.{
.name="quick-start",
.root_source_file= .{ .path="src/main.zig" },
.target=target,
.optimize=optimize,
});
exe.addModule("json", json_mod);
construn_cmd=b.addRunArtifact(exe);
construn_step=b.step("run", "Run the app");
run_step.dependOn(&run_cmd.step);
}build.zig.zon
.{
.name="quick-start",
.version="0.1.0",
.paths= .{""},
.dependencies= .{
.json= .{
.url="https://github.com/getty-zig/json/archive/3e3cf7b.tar.gz",
.hash="122017ccb426b5f5690fdda438134852e940796b0ac619eb2648782a7879146f4fcd",
},
},
}src/main.zig
conststd=@import("std");
constjson=@import("json");
constally=std.heap.page_allocator;
constPoint=struct {
x: i32,
y: i32,
};
pubfnmain() !void {
constvalue=Point{ .x=1, .y=2 };
// Serialize a Point value into JSON.constserialized=tryjson.toSlice(ally, value);
deferally.free(serialized);
// Deserialize JSON data into a Point value.constdeserialized=tryjson.fromSlice(ally, Point, serialized);
// Print results.std.debug.print("{s}\n", .{serialized}); // {"x":1,"y":2}std.debug.print("{}\n", .{deserialized}); // main.Point{ .x = 1, .y = 2 }
}Declare Getty as a project dependency with
zig fetch:zig fetch --save git+https://github.com/getty-zig/getty.git#<COMMIT>
Expose Getty as a module in your project's
build.zig:pubfnbuild(b: *std.Build) void { consttarget=b.standardTargetOptions(.{}); constoptimize=b.standardOptimizeOption(.{}); constopts= .{ .target=target, .optimize=optimize }; // 👈constgetty_mod=b.dependency("getty", opts).module("getty"); // 👈constexe=b.addExecutable(.{ .name="my-project", .root_source_file= .{ .path="src/main.zig" }, .target=target, .optimize=optimize, }); exe.root_module.addImport("getty", getty_mod); // 👈// ... }
Import Getty into your code:
constgetty=@import("getty");