https://github.com/durobot/zigstructprint

Small library to pretty-print Zig structs (and arrays)
https://github.com/durobot/zigstructprint

zig zig-package ziglang

Last synced: 26 days ago
JSON representation

Small library to pretty-print Zig structs (and arrays)

• Host: GitHub
• URL: https://github.com/durobot/zigstructprint
• Owner: Durobot
• License: mit
• Created: 2024-03-01T09:52:26.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-10T07:01:15.000Z (3 months ago)
• Last Synced: 2024-12-24T01:44:52.670Z (30 days ago)
• Topics: zig, zig-package, ziglang
• Language: Zig
• Homepage:
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
zigStructPrint

Small library to pretty-print Zig structs (and arrays)

**zigStructPrint** is licensed under under [the MIT License](https://en.wikipedia.org/w/index.php?title=MIT_License&useskin=vector) and available from https://github.com/Durobot/zigStructPrint

Please note that only Zig **0.14.0-dev.1421+f87dd43c1** (give or take) and up is supported because of [this breaking change](https://github.com/ziglang/zig/commit/0fe3fd01ddc2cd49c6a2b939577d16b9d2c65ea9) in the Zig standard library. If you need zigStructPrint for an earlier version of Zig, get [this version](https://github.com/Durobot/zigStructPrint/releases/tag/v0.1-beta) instead.

To use, either drop [zsp.zig](https://github.com/Durobot/zigStructPrint/blob/main/src/zsp.zig) into your project, or, if you prefer Zig package manager:

1. In `build.zig.zon`, in `.dependencies`, add

   ```zig

   .zigStructPrint =

   .{

       .url = "https://github.com/Durobot/zigStructPrint/archive/.tar.gz",

       .hash = "" // Use arbitrary hash, get correct hash from the error 

   }

   ```

2. In `build.zig`, in `pub fn build`, before `b.installArtifact(exe);`, add

   ```zig

   const zsp = b.dependency("zigStructPrint",

   .{

       .target = target,

       .optimize = optimize,

   });

   exe.root_module.addImport("zigStructPrint", zsp.module("zigStructPrint"));

   ```

Build with `zig build`, as you normally do.

Actually printing out your struct:

```zig

const zsp = @import("zigStructPrint");

. . .

const MyStruct = struct

{

    a: i8 = -10,

    b: u32 = 10,

    c: [3]u8 = [_]u8 { 1, 2, 3 },

    d: [2]Nested = .{ .{ .f = 10.0, .g = "Hello" }, .{ .f = -20.0, .g = "Bye" }, },

    e: [3]Color = .{ .red, .green, .yellow },

    const Nested = struct { f: f32, g: []const u8 };

    const Color = enum { red, yellow, green };

};

const ms = MyStruct {};

zsp.printStruct(ms, true, 0); // try `false` to get full type names

```

And the output is:

```zig

{

    a: i8 = -10

    b: u32 = 10

    c: [3]u8 = [ 1, 2, 3, ]

    d: [2]Nested = [ { f: f32 = 10, g: []const u8 = "Hello", }, { f: f32 = -20, g: []const u8 = "Bye", }, ]

    e: [3]Color = [ red, green, yellow, ]

}

```