Struct ntfs::NtfsFileFlags
source · pub struct NtfsFileFlags(_);
Expand description
Flags returned by NtfsFile::flags
.
Implementations§
source§impl NtfsFileFlags
impl NtfsFileFlags
sourcepub const IS_DIRECTORY: Self = _
pub const IS_DIRECTORY: Self = _
Record is a directory.
source§impl NtfsFileFlags
impl NtfsFileFlags
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl NtfsFileFlags
impl NtfsFileFlags
sourcepub const fn iter(&self) -> Iter<NtfsFileFlags>
pub const fn iter(&self) -> Iter<NtfsFileFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<NtfsFileFlags>
pub const fn iter_names(&self) -> IterNames<NtfsFileFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for NtfsFileFlags
impl Binary for NtfsFileFlags
source§impl BitAnd<NtfsFileFlags> for NtfsFileFlags
impl BitAnd<NtfsFileFlags> for NtfsFileFlags
source§impl BitAndAssign<NtfsFileFlags> for NtfsFileFlags
impl BitAndAssign<NtfsFileFlags> for NtfsFileFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<NtfsFileFlags> for NtfsFileFlags
impl BitOr<NtfsFileFlags> for NtfsFileFlags
source§fn bitor(self, other: NtfsFileFlags) -> Self
fn bitor(self, other: NtfsFileFlags) -> Self
Returns the union of the two sets of flags.
§type Output = NtfsFileFlags
type Output = NtfsFileFlags
|
operator.source§impl BitOrAssign<NtfsFileFlags> for NtfsFileFlags
impl BitOrAssign<NtfsFileFlags> for NtfsFileFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<NtfsFileFlags> for NtfsFileFlags
impl BitXor<NtfsFileFlags> for NtfsFileFlags
source§impl BitXorAssign<NtfsFileFlags> for NtfsFileFlags
impl BitXorAssign<NtfsFileFlags> for NtfsFileFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for NtfsFileFlags
impl Clone for NtfsFileFlags
source§fn clone(&self) -> NtfsFileFlags
fn clone(&self) -> NtfsFileFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NtfsFileFlags
impl Debug for NtfsFileFlags
source§impl Display for NtfsFileFlags
impl Display for NtfsFileFlags
source§impl Extend<NtfsFileFlags> for NtfsFileFlags
impl Extend<NtfsFileFlags> for NtfsFileFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 NtfsFileFlags
impl Flags for NtfsFileFlags
source§const FLAGS: &'static [Flag<NtfsFileFlags>] = _
const FLAGS: &'static [Flag<NtfsFileFlags>] = _
source§fn from_bits_retain(bits: u16) -> NtfsFileFlags
fn from_bits_retain(bits: u16) -> NtfsFileFlags
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> 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,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<NtfsFileFlags> for NtfsFileFlags
impl FromIterator<NtfsFileFlags> for NtfsFileFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for NtfsFileFlags
impl Hash for NtfsFileFlags
source§impl IntoIterator for NtfsFileFlags
impl IntoIterator for NtfsFileFlags
source§impl LowerHex for NtfsFileFlags
impl LowerHex for NtfsFileFlags
source§impl Not for NtfsFileFlags
impl Not for NtfsFileFlags
source§impl Octal for NtfsFileFlags
impl Octal for NtfsFileFlags
source§impl Ord for NtfsFileFlags
impl Ord for NtfsFileFlags
source§fn cmp(&self, other: &NtfsFileFlags) -> Ordering
fn cmp(&self, other: &NtfsFileFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<NtfsFileFlags> for NtfsFileFlags
impl PartialEq<NtfsFileFlags> for NtfsFileFlags
source§fn eq(&self, other: &NtfsFileFlags) -> bool
fn eq(&self, other: &NtfsFileFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<NtfsFileFlags> for NtfsFileFlags
impl PartialOrd<NtfsFileFlags> for NtfsFileFlags
source§fn partial_cmp(&self, other: &NtfsFileFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &NtfsFileFlags) -> Option<Ordering>
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 PublicFlags for NtfsFileFlags
impl PublicFlags for NtfsFileFlags
source§impl Sub<NtfsFileFlags> for NtfsFileFlags
impl Sub<NtfsFileFlags> for NtfsFileFlags
source§impl SubAssign<NtfsFileFlags> for NtfsFileFlags
impl SubAssign<NtfsFileFlags> for NtfsFileFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.