Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

tuple

Like value, but always serializes val as a tuple.

Will fail at comptime if val is not a tuple, array, pointer to an array, or slice.

Serializer.tuple

pub fn tuple(self: *Serializer, val: anytype, options: ValueOptions) Error!void

File

lib/std/zon/Serializer.zig:299

Code

pub fn tuple(self: *Serializer, val: anytype, options: ValueOptions) Error!void {
    comptime assert(!typeIsRecursive(@TypeOf(val)));
    try self.tupleArbitraryDepth(val, options);
}