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.

discardAll

Skips the next n bytes from the stream, advancing the seek position.

Unlike toss which is infallible, in this function n can be any amount.

Returns error.EndOfStream if fewer than n bytes could be discarded.

See also:

Reader.discardAll
pub fn discardAll(r: *Reader, n: usize) Error!void

File

lib/std/Io/Reader.zig:610

Code

pub fn discardAll(r: *Reader, n: usize) Error!void {
    if ((try r.discardShort(n)) != n) return error.EndOfStream;
}