Struct Flags

pub struct Flags { /* private fields */ }

Windows volume file system flags.

Reference: https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-getvolumeinformationw

Implementations

impl Flags

pub const FILE_CASE_PRESERVED_NAMES: Flags = _

The specified volume supports preserved case of file names when it places a name on disk.

pub const FILE_CASE_SENSITIVE_SEARCH: Flags = _

The specified volume supports case-sensitive file names.

pub const FILE_DAX_VOLUME: Flags = _

The specified volume is a direct access (DAX) volume.

pub const FILE_FILE_COMPRESSION: Flags = _

The specified volume supports file-based compression.

pub const FILE_NAMED_STREAMS: Flags = _

The specified volume supports named streams.

pub const FILE_PERSISTENT_ACLS: Flags = _

The specified volume preserves and enforces access control lists (ACL).

pub const FILE_READ_ONLY_VOLUME: Flags = _

The specified volume is read-only.

pub const FILE_SEQUENTIAL_WRITE_ONCE: Flags = _

The specified volume supports a single sequential write.

pub const FILE_SUPPORTS_ENCRYPTION: Flags = _

The specified volume supports the Encrypted File System (EFS).

pub const FILE_SUPPORTS_EXTENDED_ATTRIBUTES: Flags = _

The specified volume supports extended attributes.

pub const FILE_SUPPORTS_HARD_LINKS: Flags = _

The specified volume supports hard links. For more information, see Hard Links and Junctions.

pub const FILE_SUPPORTS_OBJECT_IDS: Flags = _

The specified volume supports object identifiers.

pub const FILE_SUPPORTS_OPEN_BY_FILE_ID: Flags = _

The file system supports open by FileID.

pub const FILE_SUPPORTS_REPARSE_POINTS: Flags = _

The specified volume supports reparse points.

pub const FILE_SUPPORTS_SPARSE_FILES: Flags = _

The specified volume supports sparse files.

pub const FILE_SUPPORTS_TRANSACTIONS: Flags = _

The specified volume supports transactions.

pub const FILE_SUPPORTS_USN_JOURNAL: Flags = _

The specified volume supports update sequence number (USN) journals.

pub const FILE_UNICODE_ON_DISK: Flags = _

The specified volume supports Unicode in file names as they appear on disk.

pub const FILE_VOLUME_IS_COMPRESSED: Flags = _

The specified volume is a compressed volume, for example, a DoubleSpace volume.

pub const FILE_VOLUME_QUOTAS: Flags = _

The specified volume supports disk quotas.

pub const fn empty() -> Flags

Returns an empty set of flags

pub const fn all() -> Flags

Returns the set containing all flags.

pub const fn bits(&self) -> DWORD

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: DWORD) -> Option<Flags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: DWORD) -> Flags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: DWORD) -> Flags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Flags) -> bool

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Flags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Flags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Flags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Flags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd for Flags

fn bitand(self, other: Flags) -> Flags

Returns the intersection between the two sets of flags.

type Output = Flags

The resulting type after applying the & operator.

impl BitAndAssign for Flags

fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl BitOr for Flags

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

Returns the union of the two sets of flags.

type Output = Flags

The resulting type after applying the | operator.

impl BitOrAssign for Flags

fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl BitXor for Flags

fn bitxor(self, other: Flags) -> Flags

Returns the left flags, but with all the right flags toggled.

type Output = Flags

The resulting type after applying the ^ operator.

impl BitXorAssign for Flags

fn bitxor_assign(&mut self, other: Flags)

Toggles the set of flags.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Extend<Flags> for Flags

fn extend<T: IntoIterator<Item = Flags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Flags> for Flags

fn from_iter<T: IntoIterator<Item = Flags>>(iterator: T) -> Flags

Creates a value from an iterator.

impl Hash for Flags

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 LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

fn not(self) -> Flags

Returns the complement of this set of flags.

type Output = Flags

The resulting type after applying the ! operator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

fn cmp(&self, other: &Flags) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Flags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Flags

fn partial_cmp(&self, other: &Flags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Flags

fn sub(self, other: Flags) -> Flags

Returns the set difference of the two sets of flags.

type Output = Flags

The resulting type after applying the - operator.

impl SubAssign for Flags

fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

impl Eq for Flags

impl StructuralPartialEq for Flags