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.

takeByte

Reads 1 byte from the stream or returns error.EndOfStream.

Asserts the buffer capacity is nonzero.

Reader.takeByte

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

File

lib/std/Io/Reader.zig:1161

Code

pub fn takeByte(r: *Reader) Error!u8 {
    const result = try peekByte(r);
    r.seek += 1;
    return result;
}