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.

walk

Recursively iterates over a directory.

dir must have been opened with OpenOptions.iterate set to true.

Walker.deinit releases allocated memory and directory handles.

The order of returned file system entries is undefined.

dir will not be closed after walking it.

See also:

Dir.walk
pub fn walk(dir: Dir, allocator: Allocator) Allocator.Error!Walker

File

lib/std/Io/Dir.zig:397

Code

pub fn walk(dir: Dir, allocator: Allocator) Allocator.Error!Walker {
    return .{ .inner = try walkSelectively(dir, allocator) };
}