Struct ntfs::NtfsIndexEntryFlags
source · pub struct NtfsIndexEntryFlags(_);
Expand description
Flags returned by NtfsIndexEntry::flags
.
Implementations§
source§impl NtfsIndexEntryFlags
impl NtfsIndexEntryFlags
sourcepub const HAS_SUBNODE: Self = _
pub const HAS_SUBNODE: Self = _
This Index Entry points to a sub-node.
sourcepub const LAST_ENTRY: Self = _
pub const LAST_ENTRY: Self = _
This is the last Index Entry in the list.
source§impl NtfsIndexEntryFlags
impl NtfsIndexEntryFlags
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> 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 NtfsIndexEntryFlags
impl NtfsIndexEntryFlags
sourcepub const fn iter(&self) -> Iter<NtfsIndexEntryFlags>
pub const fn iter(&self) -> Iter<NtfsIndexEntryFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<NtfsIndexEntryFlags>
pub const fn iter_names(&self) -> IterNames<NtfsIndexEntryFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for NtfsIndexEntryFlags
impl Binary for NtfsIndexEntryFlags
source§impl BitAndAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl BitAndAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
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<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl BitOr<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn bitor(self, other: NtfsIndexEntryFlags) -> Self
fn bitor(self, other: NtfsIndexEntryFlags) -> Self
Returns the union of the two sets of flags.
§type Output = NtfsIndexEntryFlags
type Output = NtfsIndexEntryFlags
|
operator.source§impl BitOrAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl BitOrAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl BitXorAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for NtfsIndexEntryFlags
impl Clone for NtfsIndexEntryFlags
source§fn clone(&self) -> NtfsIndexEntryFlags
fn clone(&self) -> NtfsIndexEntryFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NtfsIndexEntryFlags
impl Debug for NtfsIndexEntryFlags
source§impl Display for NtfsIndexEntryFlags
impl Display for NtfsIndexEntryFlags
source§impl Extend<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl Extend<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
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 NtfsIndexEntryFlags
impl Flags for NtfsIndexEntryFlags
source§const FLAGS: &'static [Flag<NtfsIndexEntryFlags>] = _
const FLAGS: &'static [Flag<NtfsIndexEntryFlags>] = _
source§fn from_bits_retain(bits: u8) -> NtfsIndexEntryFlags
fn from_bits_retain(bits: u8) -> NtfsIndexEntryFlags
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<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl FromIterator<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
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 NtfsIndexEntryFlags
impl Hash for NtfsIndexEntryFlags
source§impl IntoIterator for NtfsIndexEntryFlags
impl IntoIterator for NtfsIndexEntryFlags
source§impl LowerHex for NtfsIndexEntryFlags
impl LowerHex for NtfsIndexEntryFlags
source§impl Not for NtfsIndexEntryFlags
impl Not for NtfsIndexEntryFlags
source§impl Octal for NtfsIndexEntryFlags
impl Octal for NtfsIndexEntryFlags
source§impl Ord for NtfsIndexEntryFlags
impl Ord for NtfsIndexEntryFlags
source§fn cmp(&self, other: &NtfsIndexEntryFlags) -> Ordering
fn cmp(&self, other: &NtfsIndexEntryFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl PartialEq<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn eq(&self, other: &NtfsIndexEntryFlags) -> bool
fn eq(&self, other: &NtfsIndexEntryFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl PartialOrd<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn partial_cmp(&self, other: &NtfsIndexEntryFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &NtfsIndexEntryFlags) -> 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 NtfsIndexEntryFlags
impl PublicFlags for NtfsIndexEntryFlags
source§impl Sub<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl Sub<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§impl SubAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
impl SubAssign<NtfsIndexEntryFlags> for NtfsIndexEntryFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.