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.

discardDelimiterExclusive

Reads from the stream until specified byte is found, discarding all data, excluding the delimiter.

Returns the number of bytes discarded.

Succeeds if stream ends before delimiter found. End of stream can be detected by checking if the delimiter is buffered.

File

lib/std/Io/Reader.zig:1063

Code

pub fn discardDelimiterExclusive(r: *Reader, delimiter: u8) ShortError!usize {
    return discardDelimiterLimit(r, delimiter, .unlimited) catch |err| switch (err) {
        error.StreamTooLong => unreachable, // unlimited is passed
        else => |e| return e,
    };
}