Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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. Public Function

takeSentinel

Public Function
std.Io.Reader.takeSentinel
pub fn takeSentinel(r: *Reader, comptime sentinel: u8) DelimiterError![:sentinel]u8

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.

See also:

Params

Errors

ReadFailed

See the Reader implementation for detailed diagnostics.

EndOfStream

For "inclusive" functions, stream ended before the delimiter was found. For "exclusive" functions, stream ended and there are no more bytes to return.

StreamTooLong

The delimiter was not found within a number of bytes matching the capacity of the Reader.

File

Io/Reader.zig:773
773
774
775
776
777
pub fn takeSentinel(r: *Reader, comptime sentinel: u8) DelimiterError![:sentinel]u8 {
    const result = try r.peekSentinel(sentinel);
    r.toss(result.len + 1);
    return result;
}