Struct hwlocality::topology::export::xml::XMLExportFlags
source · pub struct XMLExportFlags(/* private fields */);
Expand description
Flags to be given to Topology::export_xml()
Implementations§
source§impl XMLExportFlags
impl XMLExportFlags
sourcepub const fn bits(&self) -> hwloc_topology_export_xml_flags_e
pub const fn bits(&self) -> hwloc_topology_export_xml_flags_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_topology_export_xml_flags_e) -> Option<Self>
pub const fn from_bits(bits: hwloc_topology_export_xml_flags_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_topology_export_xml_flags_e) -> Self
pub const fn from_bits_truncate(bits: hwloc_topology_export_xml_flags_e) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: hwloc_topology_export_xml_flags_e) -> Self
pub const fn from_bits_retain(bits: hwloc_topology_export_xml_flags_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 XMLExportFlags
impl XMLExportFlags
sourcepub const fn iter(&self) -> Iter<XMLExportFlags>
pub const fn iter(&self) -> Iter<XMLExportFlags>
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<XMLExportFlags>
pub const fn iter_names(&self) -> IterNames<XMLExportFlags>
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 XMLExportFlags
Available on crate feature proptest
only.
impl Arbitrary for XMLExportFlags
proptest
only.§type Parameters = ()
type Parameters = ()
arbitrary_with
accepts for configuration
of the generated Strategy
. Parameters must implement Default
.§type Strategy = Map<Subsequence<XMLExportFlags>, fn(_: Vec<XMLExportFlags>) -> XMLExportFlags>
type Strategy = Map<Subsequence<XMLExportFlags>, fn(_: Vec<XMLExportFlags>) -> XMLExportFlags>
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 XMLExportFlags
impl Binary for XMLExportFlags
source§impl BitAnd for XMLExportFlags
impl BitAnd for XMLExportFlags
source§impl BitAndAssign for XMLExportFlags
impl BitAndAssign for XMLExportFlags
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 XMLExportFlags
impl BitOr for XMLExportFlags
source§fn bitor(self, other: XMLExportFlags) -> Self
fn bitor(self, other: XMLExportFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = XMLExportFlags
type Output = XMLExportFlags
|
operator.source§impl BitOrAssign for XMLExportFlags
impl BitOrAssign for XMLExportFlags
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 XMLExportFlags
impl BitXor for XMLExportFlags
source§impl BitXorAssign for XMLExportFlags
impl BitXorAssign for XMLExportFlags
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 XMLExportFlags
impl Clone for XMLExportFlags
source§fn clone(&self) -> XMLExportFlags
fn clone(&self) -> XMLExportFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for XMLExportFlags
impl Debug for XMLExportFlags
source§impl Default for XMLExportFlags
impl Default for XMLExportFlags
source§fn default() -> XMLExportFlags
fn default() -> XMLExportFlags
source§impl Extend<XMLExportFlags> for XMLExportFlags
impl Extend<XMLExportFlags> for XMLExportFlags
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 XMLExportFlags
impl Flags for XMLExportFlags
source§const FLAGS: &'static [Flag<XMLExportFlags>] = _
const FLAGS: &'static [Flag<XMLExportFlags>] = _
source§fn bits(&self) -> hwloc_topology_export_xml_flags_e
fn bits(&self) -> hwloc_topology_export_xml_flags_e
source§fn from_bits_retain(bits: hwloc_topology_export_xml_flags_e) -> XMLExportFlags
fn from_bits_retain(bits: hwloc_topology_export_xml_flags_e) -> XMLExportFlags
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<XMLExportFlags> for XMLExportFlags
impl FromIterator<XMLExportFlags> for XMLExportFlags
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 XMLExportFlags
impl Hash for XMLExportFlags
source§impl IntoIterator for XMLExportFlags
impl IntoIterator for XMLExportFlags
source§impl LowerHex for XMLExportFlags
impl LowerHex for XMLExportFlags
source§impl Not for XMLExportFlags
impl Not for XMLExportFlags
source§impl Octal for XMLExportFlags
impl Octal for XMLExportFlags
source§impl PartialEq for XMLExportFlags
impl PartialEq for XMLExportFlags
source§fn eq(&self, other: &XMLExportFlags) -> bool
fn eq(&self, other: &XMLExportFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for XMLExportFlags
impl PublicFlags for XMLExportFlags
source§impl Sub for XMLExportFlags
impl Sub for XMLExportFlags
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 = XMLExportFlags
type Output = XMLExportFlags
-
operator.source§impl SubAssign for XMLExportFlags
impl SubAssign for XMLExportFlags
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.