struct OpenFileOptions [src]

Fields

access_mask: ACCESS_MASK

dir: ?HANDLE = null

sa: ?*SECURITY_ATTRIBUTES = null

share_access: ULONG = FILE_SHARE_WRITE | FILE_SHARE_READ | FILE_SHARE_DELETE

creation: ULONG

filter: Filter = .file_onlyIf true, tries to open path as a directory. Defaults to false.

follow_symlinks: bool = trueIf false, tries to open path as a reparse point without dereferencing it. Defaults to true.

Members

Filter (enum)

Source

  pub const OpenFileOptions = struct {
    access_mask: ACCESS_MASK,
    dir: ?HANDLE = null,
    sa: ?*SECURITY_ATTRIBUTES = null,
    share_access: ULONG = FILE_SHARE_WRITE | FILE_SHARE_READ | FILE_SHARE_DELETE,
    creation: ULONG,
    /// If true, tries to open path as a directory.
    /// Defaults to false.
    filter: Filter = .file_only,
    /// If false, tries to open path as a reparse point without dereferencing it.
    /// Defaults to true.
    follow_symlinks: bool = true,

    pub const Filter = enum {
        /// Causes `OpenFile` to return `error.IsDir` if the opened handle would be a directory.
        file_only,
        /// Causes `OpenFile` to return `error.NotDir` if the opened handle would be a file.
        dir_only,
        /// `OpenFile` does not discriminate between opening files and directories.
        any,
    };
}  