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 › zig › string_literal › parseWrite Public Function parseWrite Doc Source Public Function std.zig.string_literal.parseWrite
pub fn parseWrite (writer : *Writer , bytes : []const u8 ) Writer .Error !Result Params writer : *Writer bytes : []const u8 File zig/string_literal.zig: 322
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356 pub fn parseWrite (writer : *Writer , bytes : []const u8 ) Writer .Error !Result {
assert (bytes .len >= 2 and bytes [0 ] == '"' and bytes [bytes .len - 1 ] == '"' );
var index : usize = 1 ;
while (true ) {
const b = bytes [index ];
switch (b ) {
'\\' => {
const escape_char_index = index + 1 ;
const result = parseEscapeSequence (bytes , &index );
switch (result ) {
.success => |codepoint | {
if (bytes [escape_char_index ] == 'u' ) {
var buf : [4 ]u8 = undefined ;
const len = utf8Encode (codepoint , &buf ) catch {
return .{ .failure = .{ .invalid_unicode_codepoint = escape_char_index + 1 } };
};
try writer .writeAll (buf [0 ..len ]);
} else {
try writer .writeByte (@as (u8 , @intCast (codepoint )));
}
},
.failure => |err | return .{ .failure = err },
}
},
'\n' => return .{ .failure = .{ .invalid_character = index } },
'"' => return .success ,
else => {
try writer .writeByte (b );
index += 1 ;
},
}
}
}
Parses
bytesas a Zig string literal and writes the result to theWritertype.Asserts
byteshas '"' at beginning and end.