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.

peekArray

Returns the next n bytes from the stream as an array, filling the buffer as necessary, without advancing the seek position.

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:595

Code

pub fn peekArray(r: *Reader, comptime n: usize) Error!*[n]u8 {
    return (try r.peek(n))[0..n];
}