Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getty-zig/getty
A (de)serialization framework for Zig
https://github.com/getty-zig/getty
getty serialization zig ziglang
Last synced: 8 days ago
JSON representation
A (de)serialization framework for Zig
- Host: GitHub
- URL: https://github.com/getty-zig/getty
- Owner: getty-zig
- License: mit
- Created: 2021-04-06T14:54:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T17:56:26.000Z (6 months ago)
- Last Synced: 2024-10-01T03:21:18.125Z (2 months ago)
- Topics: getty, serialization, zig, ziglang
- Language: Zig
- Homepage: https://getty.so
- Size: 151 MB
- Stars: 191
- Watchers: 4
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zig - getty-zig/getty
- awesome-zig - getty🗒️Serialization framework for Zig
README
# Getty
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 `std` types.
- Granular customization for existing and remote types.
- Data models that serve as simple and generic baselines for (de)serializers.
## Quick Start
build.zig
```zig
const std = @import("std");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
const opts = .{ .target = target, .optimize = optimize };
const json_mod = b.dependency("json", opts).module("json");
const exe = b.addExecutable(.{
.name = "quick-start",
.root_source_file = .{ .path = "src/main.zig" },
.target = target,
.optimize = optimize,
});
exe.addModule("json", json_mod);
const run_cmd = b.addRunArtifact(exe);
const run_step = b.step("run", "Run the app");
run_step.dependOn(&run_cmd.step);
}
```
build.zig.zon
```zig
.{
.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
```zig
const std = @import("std");
const json = @import("json");
const ally = std.heap.page_allocator;
const Point = struct {
x: i32,
y: i32,
};
pub fn main() !void {
const value = Point{ .x = 1, .y = 2 };
// Serialize a Point value into JSON.
const serialized = try json.toSlice(ally, value);
defer ally.free(serialized);
// Deserialize JSON data into a Point value.
const deserialized = try json.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 }
}
```
## Installation
1. Declare Getty as a project dependency with `zig fetch`:
```sh
zig fetch --save git+https://github.com/getty-zig/getty.git#
```
2. Expose Getty as a module in your project's `build.zig`:
```zig
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
const opts = .{ .target = target, .optimize = optimize }; // 👈
const getty_mod = b.dependency("getty", opts).module("getty"); // 👈
const exe = b.addExecutable(.{
.name = "my-project",
.root_source_file = .{ .path = "src/main.zig" },
.target = target,
.optimize = optimize,
});
exe.root_module.addImport("getty", getty_mod); // 👈
// ...
}
```
3. Import Getty into your code:
```zig
const getty = @import("getty");
```
## Resources
- [Website](https://getty.so/)
- [Tutorial](https://getty.so/user-guide/tutorial/)
- [Examples](examples)
- [API Reference](https://docs.getty.so/)
- [Contributing](https://getty.so/contributing/)