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.

takeSentinel

Returns a slice of the next bytes of buffered data from the stream until sentinel is found, advancing the seek position past the sentinel.

Returned slice has a sentinel.

Invalidates previously returned values from peek.

File

lib/std/Io/Reader.zig:773

Code

pub fn takeSentinel(r: *Reader, comptime sentinel: u8) DelimiterError![:sentinel]u8 {
    const result = try r.peekSentinel(sentinel);
    r.toss(result.len + 1);
    return result;
}