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.

toss

Skips the next n bytes from the stream, advancing the seek position. This is typically and safely used after peek.

Asserts that the number of bytes buffered is at least as many as n.

The "tossed" memory remains alive until a "peek" operation occurs.

See also:

Reader.toss
pub fn toss(r: *Reader, n: usize) void

File

lib/std/Io/Reader.zig:548

Code

pub fn toss(r: *Reader, n: usize) void {
    r.seek += n;
    assert(r.seek <= r.end);
}