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.

iterateAssumeFirstIteration

Like iterate, but will not reset the directory cursor before the first iteration. This should only be used in cases where it is known that the Dir has not had its cursor modified yet (e.g. it was just opened).

Dir.iterateAssumeFirstIteration

pub fn iterateAssumeFirstIteration(dir: Dir) Iterator

File

lib/std/Io/Dir.zig:218

Code

pub fn iterateAssumeFirstIteration(dir: Dir) Iterator {
    return .init(dir, .reading);
}