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 standard library. Public Struct
The containing directory. This can be used to operate directly on basename rather than path, avoiding error.NameTooLong for deeply nested paths. The directory remains open until next or deinit is called.
Returns the depth of the entry relative to the initial directory. Returns 1 for a direct child of the initial directory, 2 for an entry within a direct child of the initial directory, etc.
File
Io/Dir.zig:345
345346347348349350351352353354355356357358359360
pubconstEntry = struct {
/// The containing directory. This can be used to operate directly on `basename`/// rather than `path`, avoiding `error.NameTooLong` for deeply nested paths./// The directory remains open until `next` or `deinit` is called.dir: Dir,
basename: [:0]constu8,
path: [:0]constu8,
kind: File.Kind,
/// Returns the depth of the entry relative to the initial directory./// Returns 1 for a direct child of the initial directory, 2 for an entry/// within a direct child of the initial directory, etc.pubfndepth(self: Walker.Entry) usize {
returnstd.mem.countScalar(u8, self.path, path.sep) + 1;
}
}
