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 standard library.
std › zon › stringify › serializeMaxDepth Public Function serializeMaxDepth Doc Source Public Function std.zon.stringify.serializeMaxDepth
pub fn serializeMaxDepth (
val : anytype ,
options : SerializeOptions ,
writer : *Writer ,
depth : usize ,
) Serializer .DepthError !void Params File zon/stringify.zig: 64
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80 pub fn serializeMaxDepth (
val : anytype ,
options : SerializeOptions ,
writer : *Writer ,
depth : usize ,
) Serializer .DepthError !void {
var s : Serializer = .{
.writer = writer ,
.options = .{ .whitespace = options .whitespace },
};
try s .valueMaxDepth (val , .{
.emit_codepoint_literals = options .emit_codepoint_literals ,
.emit_strings_as_containers = options .emit_strings_as_containers ,
.emit_default_optional_fields = options .emit_default_optional_fields ,
.escape_non_ascii = options .escape_non_ascii ,
}, depth );
}
Like
serialize, but recursive types are allowed.Returns
error.ExceededMaxDepthifdepthis exceeded. Every nested value adds one to a value's depth.