#[repr(transparent)]pub struct FileFlag(_);
fs
only.Expand description
File flags.
Implementations§
source§impl FileFlag
impl FileFlag
sourcepub const SF_ARCHIVED: Self = _
pub const SF_ARCHIVED: Self = _
The file has been archived.
sourcepub const SF_IMMUTABLE: Self = _
pub const SF_IMMUTABLE: Self = _
The file may not be changed.
sourcepub const SF_SETTABLE: Self = _
pub const SF_SETTABLE: Self = _
Mask of superuser changeable flags
sourcepub const UF_COMPRESSED: Self = _
pub const UF_COMPRESSED: Self = _
File is compressed at the file system level.
sourcepub const UF_HIDDEN: Self = _
pub const UF_HIDDEN: Self = _
The file may be hidden from directory listings at the application’s discretion.
sourcepub const UF_IMMUTABLE: Self = _
pub const UF_IMMUTABLE: Self = _
The file may not be changed.
sourcepub const UF_SETTABLE: Self = _
pub const UF_SETTABLE: Self = _
Mask of owner changeable flags.
sourcepub const UF_TRACKED: Self = _
pub const UF_TRACKED: Self = _
File renames and deletes are tracked.
source§impl FileFlag
impl FileFlag
sourcepub const fn bits(&self) -> type_of_file_flag
pub const fn bits(&self) -> type_of_file_flag
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: type_of_file_flag) -> Option<Self>
pub const fn from_bits(bits: type_of_file_flag) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: type_of_file_flag) -> Self
pub const fn from_bits_truncate(bits: type_of_file_flag) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: type_of_file_flag) -> Self
pub const fn from_bits_retain(bits: type_of_file_flag) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
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.
sourcepub const fn contains(&self, other: Self) -> bool
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.
sourcepub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl FileFlag
impl FileFlag
sourcepub const fn iter(&self) -> Iter<FileFlag>
pub const fn iter(&self) -> Iter<FileFlag>
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.
sourcepub const fn iter_names(&self) -> IterNames<FileFlag>
pub const fn iter_names(&self) -> IterNames<FileFlag>
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§
source§impl BitAndAssign<FileFlag> for FileFlag
impl BitAndAssign<FileFlag> for FileFlag
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign<FileFlag> for FileFlag
impl BitOrAssign<FileFlag> for FileFlag
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign<FileFlag> for FileFlag
impl BitXorAssign<FileFlag> for FileFlag
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Extend<FileFlag> for FileFlag
impl Extend<FileFlag> for FileFlag
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for FileFlag
impl Flags for FileFlag
source§fn bits(&self) -> type_of_file_flag
fn bits(&self) -> type_of_file_flag
source§fn from_bits_retain(bits: type_of_file_flag) -> FileFlag
fn from_bits_retain(bits: type_of_file_flag) -> FileFlag
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<FileFlag> for FileFlag
impl FromIterator<FileFlag> for FileFlag
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for FileFlag
impl IntoIterator for FileFlag
source§impl Ord for FileFlag
impl Ord for FileFlag
source§impl PartialEq<FileFlag> for FileFlag
impl PartialEq<FileFlag> for FileFlag
source§impl PartialOrd<FileFlag> for FileFlag
impl PartialOrd<FileFlag> for FileFlag
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<FileFlag> for FileFlag
impl Sub<FileFlag> for FileFlag
source§impl SubAssign<FileFlag> for FileFlag
impl SubAssign<FileFlag> for FileFlag
source§fn sub_assign(&mut self, other: Self)
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.