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.

peekGreedy

Returns all the next buffered bytes, after filling the buffer to ensure it contains at least n bytes.

Invalidates previously returned values from peek and peekGreedy.

Asserts that the Reader was initialized with a buffer capacity at least as big as n.

If there are fewer than n bytes left in the stream, error.EndOfStream is returned instead.

File

lib/std/Io/Reader.zig:533

Code

pub fn peekGreedy(r: *Reader, n: usize) Error![]u8 {
    try r.fill(n);
    return r.buffer[r.seek..r.end];
}