Struct heim::disk::os::windows::Flags

pub struct Flags { /* fields omitted */ }

Windows volume file system flags.

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

Methods

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) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> 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: u32) -> Flags

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

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

type Output = Flags

The resulting type after applying the ! operator.

fn not(self) -> Flags

Returns the complement of this set of flags.

impl Hash for Flags

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Extend<Flags> for Flags

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

Extends a collection with the contents of an iterator.

impl BitXor<Flags> for Flags

type Output = Flags

The resulting type after applying the ^ operator.

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

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

impl Binary for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

impl BitAndAssign<Flags> for Flags

fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl BitXorAssign<Flags> 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 Eq for Flags

impl Sub<Flags> for Flags

type Output = Flags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl BitAnd<Flags> for Flags

type Output = Flags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<Flags> for Flags

type Output = Flags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl PartialEq<Flags> for Flags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Octal for Flags

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

Formats the value using the given formatter.

impl FromIterator<Flags> for Flags

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

Creates a value from an iterator.

impl Debug for Flags

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

Formats the value using the given formatter.

impl BitOrAssign<Flags> for Flags

fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl PartialOrd<Flags> 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: &Flags) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl UpperHex for Flags

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl SubAssign<Flags> for Flags

fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.