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.

peekByte

Returns the next byte from the stream or returns error.EndOfStream.

Does not advance the seek position.

Asserts the buffer capacity is nonzero.

Reader.peekByte

pub fn peekByte(r: *Reader) Error!u8

File

lib/std/Io/Reader.zig:1147

Code

pub fn peekByte(r: *Reader) Error!u8 {
    const buffer = r.buffer[0..r.end];
    const seek = r.seek;
    if (seek < buffer.len) {
        @branchHint(.likely);
        return buffer[seek];
    }
    try fill(r, 1);
    return r.buffer[r.seek];
}