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 › json › Scanner › endOfBufferInString Private Function endOfBufferInString Doc Source Private Function std.json.Scanner.endOfBufferInString
fn endOfBufferInString (self : *@This ()) !Token Params File json/Scanner.zig: 1349
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380 fn endOfBufferInString (self : *@This ()) !Token {
if (self .is_end_of_input ) return error .UnexpectedEndOfInput ;
const slice = self .takeValueSliceMinusTrailingOffset (switch (self .state ) {
// Don't include the escape sequence in the partial string.
.string_backslash => 1 ,
.string_backslash_u => 2 ,
.string_backslash_u_1 => 3 ,
.string_backslash_u_2 => 4 ,
.string_backslash_u_3 => 5 ,
.string_surrogate_half => 6 ,
.string_surrogate_half_backslash => 7 ,
.string_surrogate_half_backslash_u => 8 ,
.string_surrogate_half_backslash_u_1 => 9 ,
.string_surrogate_half_backslash_u_2 => 10 ,
.string_surrogate_half_backslash_u_3 => 11 ,
// Include everything up to the cursor otherwise.
.string ,
.string_utf8_last_byte ,
.string_utf8_second_to_last_byte ,
.string_utf8_second_to_last_byte_guard_against_overlong ,
.string_utf8_second_to_last_byte_guard_against_surrogate_half ,
.string_utf8_third_to_last_byte ,
.string_utf8_third_to_last_byte_guard_against_overlong ,
.string_utf8_third_to_last_byte_guard_against_too_large ,
=> 0 ,
else => unreachable ,
});
if (slice .len == 0 ) return error .BufferUnderrun ;
return Token { .partial_string = slice };
}