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

peekArray

Doc Source

Public Function

std.Io.Reader.peekArray

pub fn peekArray(r: *Reader, comptime n: usize) Error!*[n]u8

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.

Params

r: *Reader
n: usize

Errors

ReadFailed: See the Reader implementation for detailed diagnostics.
EndOfStream

File

Io/Reader.zig:596

596
597
598

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