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.

take

Equivalent to peek followed by toss.

The data returned is invalidated by the next call to take, peek, fill, and functions with those prefixes.

Reader.take

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

File

lib/std/Io/Reader.zig:562

Code

pub fn take(r: *Reader, n: usize) Error![]u8 {
    const result = try r.peek(n);
    r.toss(n);
    return result;
}