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

peek

Public Function
std.Io.Reader.peek
pub fn peek(r: *Reader, n: usize) Error![]u8

Returns the next n bytes from the stream, filling the buffer as necessary.

Invalidates previously returned values from peek.

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.

See also:

Params

Errors

ReadFailed

See the Reader implementation for detailed diagnostics.

EndOfStream

File

Io/Reader.zig:515
515
516
517
518
pub fn peek(r: *Reader, n: usize) Error![]u8 {
    try r.fill(n);
    return r.buffer[r.seek..][0..n];
}