Struct dokany::FileSystemFlags

#[repr(transparent)]
pub struct FileSystemFlags(_);

Capability flags for a filesystem.

FILE_FILE_COMPRESSION and FILE_VOL_IS_COMPRESSED are mutually exclusive

Implementations

impl FileSystemFlags

pub const CASE_SENSITIVE_SEARCH: Self = _

The specified volume supports case-sensitive file names.

pub const CASE_PRESERVED_NAMES: Self = _

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

pub const UNICODE_ON_DISK: Self = _

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

pub const PERSISTENT_ACLS: Self = _

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

For example, the NTFS file system preserves and enforces ACLs, and the FAT file system does not.

pub const FILE_COMPRESSION: Self = _

The specified volume supports file-based compression.

pub const VOLUME_QUOTAS: Self = _

The specified volume supports disk quotas.

pub const SUPPORTS_SPARSE_FILES: Self = _

The specified volume supports sparse files.

pub const SUPPORTS_REPARSE_POINTS: Self = _

The specified volume supports reparse points.

pub const SUPPORTS_REMOTE_STORAGE: Self = _

?

pub const RETURNS_CLEANUP_RESULT_INFO: Self = _

?

pub const SUPPORTS_POSIX_UNLINK_RENAME: Self = _

?

pub const VOLUME_IS_COMPRESSED: Self = _

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

pub const SUPPORTS_OBJECT_IDS: Self = _

The specified volume supports object identifiers.

pub const SUPPORTS_ENCRYPTION: Self = _

The specified volume supports the Encrypted File System (EFS). For more information, see File Encryption.

pub const NAMED_STREAMS: Self = _

The specified volume supports named streams.

pub const READ_ONLY_VOLUME: Self = _

The specified volume is read-only.

pub const SEQUENTIAL_WRITE_ONCE: Self = _

The specified volume supports a single sequential write.

pub const SUPPORTS_TRANSACTIONS: Self = _

The specified volume supports transactions. For more information, see About KTM.

pub const FILE_SUPPORTS_HARD_LINKS: Self = _

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

pub const SUPPORTS_EXTENDED_ATTRIBUTES: Self = _

The specified volume supports extended attributes.

An extended attribute is a piece of application-specific metadata that an application can associate with a file and is not part of the file’s data.

pub const SUPPORTS_OPEN_BY_FILE_ID: Self = _

The file system supports open by FileID. For more information, see FILE_ID_BOTH_DIR_INFO.

pub const SUPPORTS_USN_JOURNAL: Self = _

The specified volume supports update sequence number (USN) journals. For more information, see Change Journal Records.

pub const SUPPORTS_INTEGRITY_STREAMS: Self = _

?

pub const SUPPORTS_BLOCK_REFCOUNTING: Self = _

The specified volume supports sharing logical clusters between files on the same volume.

The file system reallocates on writes to shared clusters. Indicates that FSCTL_DUPLICATE_EXTENTS_TO_FILE is a supported operation.

pub const SUPPORTS_SPARSE_VDL: Self = _

?

pub const DAX_VOLUME: Self = _

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

pub const SUPPORTS_GHOSTING: Self = _

?

impl FileSystemFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> DWORD

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: DWORD) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FileSystemFlags

pub const fn iter(&self) -> Iter<FileSystemFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FileSystemFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FileSystemFlags

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

Formats the value using the given formatter.

impl BitAnd<FileSystemFlags> for FileSystemFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = FileSystemFlags

The resulting type after applying the & operator.

impl BitAndAssign<FileSystemFlags> for FileSystemFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr<FileSystemFlags> for FileSystemFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = FileSystemFlags

The resulting type after applying the | operator.

impl BitOrAssign<FileSystemFlags> for FileSystemFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor<FileSystemFlags> for FileSystemFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = FileSystemFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<FileSystemFlags> for FileSystemFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Extend<FileSystemFlags> for FileSystemFlags

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

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<FileSystemFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> DWORD

Get the underlying bits value.

fn from_bits_retain(bits: DWORD) -> FileSystemFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> boolwhere Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<FileSystemFlags> for FileSystemFlags

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

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for FileSystemFlags

type Item = FileSystemFlags

The type of the elements being iterated over.

type IntoIter = Iter<FileSystemFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FileSystemFlags

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

Formats the value using the given formatter.

impl Not for FileSystemFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = FileSystemFlags

The resulting type after applying the ! operator.

impl Octal for FileSystemFlags

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

Formats the value using the given formatter.

impl PublicFlags for FileSystemFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<FileSystemFlags> for FileSystemFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FileSystemFlags

The resulting type after applying the - operator.

impl SubAssign<FileSystemFlags> for FileSystemFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FileSystemFlags

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

Formats the value using the given formatter.