Struct FileRights 

pub struct FileRights(/* private fields */);

A set of file access rights other than the data rights, which are the DataAccess of the handle.

Each member is one right the documentation lists for a file, named as CreateFileW names it without its prefix: WRITE_ATTRIBUTES is FILE_WRITE_ATTRIBUTES, and the standard rights keep their names. A set is made by joining them with |:

use win_durable_ioring::windows_backend::FileRights;

let rights = FileRights::READ_ATTRIBUTES | FileRights::WRITE_ATTRIBUTES;

assert!(rights.contains(FileRights::WRITE_ATTRIBUTES));
assert!(!rights.contains(FileRights::DELETE));
assert!(FileRights::NONE.is_empty());

There is no generic right and no FILE_ALL_ACCESS. A generic right mixes the data rights, which are a type, with others, and the kernel expands it when it opens, so a set could not say what it holds. Ask for the data access with FileOptions::read and write, and for the rest with the members here.

Append-only access is not offered, by construction: there is no member for FILE_APPEND_DATA, and no data access asks for it. A write through a handle opened for appending only lands at the end of the file whatever offset it names, and the core addresses every write by offset.

The set has no constructor from a raw mask. A right Win32 defines and this table does not list cannot be expressed until the table gains it.

Implementations

impl FileRights

pub const READ_ATTRIBUTES: Self

FILE_READ_ATTRIBUTES: read the file’s attributes.

pub const WRITE_ATTRIBUTES: Self

FILE_WRITE_ATTRIBUTES: write the file’s attributes, among them its times.

pub const READ_EA: Self

FILE_READ_EA: read the file’s extended attributes.

pub const WRITE_EA: Self

FILE_WRITE_EA: write the file’s extended attributes.

pub const EXECUTE: Self

FILE_EXECUTE: execute the file, for a native code file.

pub const DELETE: Self

DELETE: delete or rename the file.

pub const READ_CONTROL: Self

READ_CONTROL: read the file’s security descriptor, without its system ACL.

pub const WRITE_DAC: Self

WRITE_DAC: change the file’s discretionary ACL.

pub const WRITE_OWNER: Self

WRITE_OWNER: change the file’s owner.

pub const SYNCHRONIZE: Self

SYNCHRONIZE: wait on the handle.

pub const ACCESS_SYSTEM_SECURITY: Self

ACCESS_SYSTEM_SECURITY: read and change the file’s system ACL. A caller the kernel does not allow it gets the kernel’s error from the open.

impl FileRights

pub const NONE: Self

No rights beyond the data access.

pub const fn union(self, other: Self) -> Self

The union of two sets.

pub const fn contains(self, other: Self) -> bool

Whether every right of other is in this set.

pub const fn is_empty(self) -> bool

Whether the set holds no right.

Trait Implementations

impl BitOr for FileRights

type Output = FileRights

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl BitOrAssign for FileRights

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for FileRights

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FileRights

impl Debug for FileRights

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileRights

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FileRights

impl Hash for FileRights

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileRights

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FileRights