pub struct RmiRealmFlags(/* private fields */);Expand description
Flags provided by the host during Realm creation
Implementations§
Source§impl RmiRealmFlags
impl RmiRealmFlags
Source§impl RmiRealmFlags
impl RmiRealmFlags
Sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u64) -> Self
pub const fn from_bits_retain(bits: u64) -> 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 RmiRealmFlags
impl RmiRealmFlags
Sourcepub const fn iter(&self) -> Iter<RmiRealmFlags>
pub const fn iter(&self) -> Iter<RmiRealmFlags>
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<RmiRealmFlags>
pub const fn iter_names(&self) -> IterNames<RmiRealmFlags>
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 Binary for RmiRealmFlags
impl Binary for RmiRealmFlags
Source§impl BitAnd for RmiRealmFlags
impl BitAnd for RmiRealmFlags
Source§impl BitAndAssign for RmiRealmFlags
impl BitAndAssign for RmiRealmFlags
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 RmiRealmFlags
impl BitOr for RmiRealmFlags
Source§fn bitor(self, other: RmiRealmFlags) -> Self
fn bitor(self, other: RmiRealmFlags) -> Self
The bitwise or (|) of the bits in two flags values.
Source§type Output = RmiRealmFlags
type Output = RmiRealmFlags
| operator.Source§impl BitOrAssign for RmiRealmFlags
impl BitOrAssign for RmiRealmFlags
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 RmiRealmFlags
impl BitXor for RmiRealmFlags
Source§impl BitXorAssign for RmiRealmFlags
impl BitXorAssign for RmiRealmFlags
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 RmiRealmFlags
impl Clone for RmiRealmFlags
Source§fn clone(&self) -> RmiRealmFlags
fn clone(&self) -> RmiRealmFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RmiRealmFlags
impl Debug for RmiRealmFlags
Source§impl Default for RmiRealmFlags
impl Default for RmiRealmFlags
Source§fn default() -> RmiRealmFlags
fn default() -> RmiRealmFlags
Source§impl Extend<RmiRealmFlags> for RmiRealmFlags
impl Extend<RmiRealmFlags> for RmiRealmFlags
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 RmiRealmFlags
impl Flags for RmiRealmFlags
Source§const FLAGS: &'static [Flag<RmiRealmFlags>]
const FLAGS: &'static [Flag<RmiRealmFlags>]
Source§fn from_bits_retain(bits: u64) -> RmiRealmFlags
fn from_bits_retain(bits: u64) -> RmiRealmFlags
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true if any unknown bits are set.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<RmiRealmFlags> for RmiRealmFlags
impl FromIterator<RmiRealmFlags> for RmiRealmFlags
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 RmiRealmFlags
impl Hash for RmiRealmFlags
Source§impl IntoIterator for RmiRealmFlags
impl IntoIterator for RmiRealmFlags
Source§impl LowerHex for RmiRealmFlags
impl LowerHex for RmiRealmFlags
Source§impl Not for RmiRealmFlags
impl Not for RmiRealmFlags
Source§impl Octal for RmiRealmFlags
impl Octal for RmiRealmFlags
Source§impl PartialEq for RmiRealmFlags
impl PartialEq for RmiRealmFlags
Source§impl PublicFlags for RmiRealmFlags
impl PublicFlags for RmiRealmFlags
Source§impl Serialize for RmiRealmFlags
impl Serialize for RmiRealmFlags
Source§impl Sub for RmiRealmFlags
impl Sub for RmiRealmFlags
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.
Source§type Output = RmiRealmFlags
type Output = RmiRealmFlags
- operator.Source§impl SubAssign for RmiRealmFlags
impl SubAssign for RmiRealmFlags
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.