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.

objectField

See Stringify for when to call this method. key is the string content of the property name. Surrounding quotes will be added and any special characters will be escaped. See also objectFieldRaw.

Stringify.objectField

pub fn objectField(self: *Stringify, key: []const u8) Error!void

File

lib/std/json/Stringify.zig:279

Code

pub fn objectField(self: *Stringify, key: []const u8) Error!void {
    if (build_mode_has_safety) assert(self.raw_streaming_mode == .none);
    try self.objectFieldStart();
    try encodeJsonString(key, self.options, self.writer);
    self.next_punctuation = .colon;
}