Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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

OpenOptions

Public Struct
std.Io.Dir.OpenOptions
pub const OpenOptions = struct

Fields

access_sub_paths: bool = true

true means the opened directory can be used as the Dir parameter for functions which operate based on an open directory handle. When false, such operations are Illegal Behavior.

iterate: bool = false

true means the opened directory can be scanned for the files and sub-directories of the result. It means the iterate function can be called.

follow_symlinks: bool = true

false means it won't dereference the symlinks.

File

Io/Dir.zig:464
464
465
466
467
468
469
470
471
472
473
474
pub const OpenOptions = struct {
    /// `true` means the opened directory can be used as the `Dir` parameter
    /// for functions which operate based on an open directory handle. When `false`,
    /// such operations are Illegal Behavior.
    access_sub_paths: bool = true,
    /// `true` means the opened directory can be scanned for the files and sub-directories
    /// of the result. It means the `iterate` function can be called.
    iterate: bool = false,
    /// `false` means it won't dereference the symlinks.
    follow_symlinks: bool = true,
}