Struct hwlocality::memory::attribute::MemoryAttributeFlags
source · pub struct MemoryAttributeFlags(/* private fields */);
hwloc-2_3_0
only.Expand description
Memory attribute flags
Exactly one of the HIGHER_IS_BEST
and LOWER_IS_BEST
flags must be set.
Implementations§
source§impl MemoryAttributeFlags
impl MemoryAttributeFlags
sourcepub const HIGHER_IS_BEST: Self = _
pub const HIGHER_IS_BEST: Self = _
The best nodes for this memory attribute are those with the higher values
This flag is mutually exclusive with LOWER_IS_BEST
.
See for instance MemoryAttribute::bandwidth()
.
sourcepub const LOWER_IS_BEST: Self = _
pub const LOWER_IS_BEST: Self = _
The best nodes for this memory attribute are those with the lower values
This flag is mutually exclusive with HIGHER_IS_BEST
.
See for instance MemoryAttribute::latency()
.
sourcepub const NEED_INITIATOR: Self = _
pub const NEED_INITIATOR: Self = _
The value returned for this memory attribute depends on the given initiator
See for instance bandwidth()
and latency()
, but not
capacity()
.
source§impl MemoryAttributeFlags
impl MemoryAttributeFlags
sourcepub const fn bits(&self) -> hwloc_memattr_flag_e
pub const fn bits(&self) -> hwloc_memattr_flag_e
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: hwloc_memattr_flag_e) -> Option<Self>
pub const fn from_bits(bits: hwloc_memattr_flag_e) -> 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: hwloc_memattr_flag_e) -> Self
pub const fn from_bits_truncate(bits: hwloc_memattr_flag_e) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: hwloc_memattr_flag_e) -> Self
pub const fn from_bits_retain(bits: hwloc_memattr_flag_e) -> 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 MemoryAttributeFlags
impl MemoryAttributeFlags
sourcepub const fn iter(&self) -> Iter<MemoryAttributeFlags>
pub const fn iter(&self) -> Iter<MemoryAttributeFlags>
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<MemoryAttributeFlags>
pub const fn iter_names(&self) -> IterNames<MemoryAttributeFlags>
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 Arbitrary for MemoryAttributeFlags
Available on crate feature proptest
only.
impl Arbitrary for MemoryAttributeFlags
proptest
only.§type Parameters = ()
type Parameters = ()
arbitrary_with
accepts for configuration
of the generated Strategy
. Parameters must implement Default
.§type Strategy = Map<Subsequence<MemoryAttributeFlags>, fn(_: Vec<MemoryAttributeFlags>) -> MemoryAttributeFlags>
type Strategy = Map<Subsequence<MemoryAttributeFlags>, fn(_: Vec<MemoryAttributeFlags>) -> MemoryAttributeFlags>
Strategy
used to generate values of type Self
.source§fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy
fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy
source§impl Binary for MemoryAttributeFlags
impl Binary for MemoryAttributeFlags
source§impl BitAnd for MemoryAttributeFlags
impl BitAnd for MemoryAttributeFlags
source§impl BitAndAssign for MemoryAttributeFlags
impl BitAndAssign for MemoryAttributeFlags
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 BitOr for MemoryAttributeFlags
impl BitOr for MemoryAttributeFlags
source§fn bitor(self, other: MemoryAttributeFlags) -> Self
fn bitor(self, other: MemoryAttributeFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = MemoryAttributeFlags
type Output = MemoryAttributeFlags
|
operator.source§impl BitOrAssign for MemoryAttributeFlags
impl BitOrAssign for MemoryAttributeFlags
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 BitXor for MemoryAttributeFlags
impl BitXor for MemoryAttributeFlags
source§impl BitXorAssign for MemoryAttributeFlags
impl BitXorAssign for MemoryAttributeFlags
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 Clone for MemoryAttributeFlags
impl Clone for MemoryAttributeFlags
source§fn clone(&self) -> MemoryAttributeFlags
fn clone(&self) -> MemoryAttributeFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MemoryAttributeFlags
impl Debug for MemoryAttributeFlags
source§impl Extend<MemoryAttributeFlags> for MemoryAttributeFlags
impl Extend<MemoryAttributeFlags> for MemoryAttributeFlags
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 MemoryAttributeFlags
impl Flags for MemoryAttributeFlags
source§const FLAGS: &'static [Flag<MemoryAttributeFlags>] = _
const FLAGS: &'static [Flag<MemoryAttributeFlags>] = _
source§fn bits(&self) -> hwloc_memattr_flag_e
fn bits(&self) -> hwloc_memattr_flag_e
source§fn from_bits_retain(bits: hwloc_memattr_flag_e) -> MemoryAttributeFlags
fn from_bits_retain(bits: hwloc_memattr_flag_e) -> MemoryAttributeFlags
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 From<MemoryAttributeFlags> for RegisterError
impl From<MemoryAttributeFlags> for RegisterError
source§fn from(value: MemoryAttributeFlags) -> Self
fn from(value: MemoryAttributeFlags) -> Self
source§impl FromIterator<MemoryAttributeFlags> for MemoryAttributeFlags
impl FromIterator<MemoryAttributeFlags> for MemoryAttributeFlags
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 Hash for MemoryAttributeFlags
impl Hash for MemoryAttributeFlags
source§impl IntoIterator for MemoryAttributeFlags
impl IntoIterator for MemoryAttributeFlags
source§impl LowerHex for MemoryAttributeFlags
impl LowerHex for MemoryAttributeFlags
source§impl Not for MemoryAttributeFlags
impl Not for MemoryAttributeFlags
source§impl Octal for MemoryAttributeFlags
impl Octal for MemoryAttributeFlags
source§impl PartialEq for MemoryAttributeFlags
impl PartialEq for MemoryAttributeFlags
source§fn eq(&self, other: &MemoryAttributeFlags) -> bool
fn eq(&self, other: &MemoryAttributeFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for MemoryAttributeFlags
impl PublicFlags for MemoryAttributeFlags
source§impl Sub for MemoryAttributeFlags
impl Sub for MemoryAttributeFlags
source§fn sub(self, other: Self) -> Self
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 = MemoryAttributeFlags
type Output = MemoryAttributeFlags
-
operator.source§impl SubAssign for MemoryAttributeFlags
impl SubAssign for MemoryAttributeFlags
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.