pub struct ComplexFlags(/* private fields */);Expand description
Different flags that may be set for a ComplexBase type.
Implementations§
Source§impl ComplexFlags
impl ComplexFlags
Sourcepub const IS_COMPLEX: Self
pub const IS_COMPLEX: Self
true if the type is a complex type, false otherwise.
Sourcepub const IS_DYNAMIC: Self
pub const IS_DYNAMIC: Self
true/// trueif the type is dynamic,false otherwise. if the type is dynamic, false otherwise.
Sourcepub const IS_CONTENT: Self
pub const IS_CONTENT: Self
true if the type is the content type of another complex type.
Source§impl ComplexFlags
impl ComplexFlags
Sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> 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 ComplexFlags
impl ComplexFlags
Sourcepub const fn iter(&self) -> Iter<ComplexFlags>
pub const fn iter(&self) -> Iter<ComplexFlags>
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<ComplexFlags>
pub const fn iter_names(&self) -> IterNames<ComplexFlags>
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.
Source§impl ComplexFlags
impl ComplexFlags
Sourcepub fn with(self, other: ComplexFlags, value: bool) -> Self
pub fn with(self, other: ComplexFlags, value: bool) -> Self
Adds the other flags to the current one if value is true and return
the result.
Sourcepub fn extract(&mut self, other: ComplexFlags) -> Self
pub fn extract(&mut self, other: ComplexFlags) -> Self
Extracts the other flags from the current ones and return them.
Trait Implementations§
Source§impl Binary for ComplexFlags
impl Binary for ComplexFlags
Source§impl BitAnd for ComplexFlags
impl BitAnd for ComplexFlags
Source§impl BitAndAssign for ComplexFlags
impl BitAndAssign for ComplexFlags
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 ComplexFlags
impl BitOr for ComplexFlags
Source§fn bitor(self, other: ComplexFlags) -> Self
fn bitor(self, other: ComplexFlags) -> Self
The bitwise or (|) of the bits in two flags values.
Source§type Output = ComplexFlags
type Output = ComplexFlags
| operator.Source§impl BitOrAssign for ComplexFlags
impl BitOrAssign for ComplexFlags
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 ComplexFlags
impl BitXor for ComplexFlags
Source§impl BitXorAssign for ComplexFlags
impl BitXorAssign for ComplexFlags
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 ComplexFlags
impl Clone for ComplexFlags
Source§fn clone(&self) -> ComplexFlags
fn clone(&self) -> ComplexFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ComplexFlags
impl Debug for ComplexFlags
Source§impl Extend<ComplexFlags> for ComplexFlags
impl Extend<ComplexFlags> for ComplexFlags
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 ComplexFlags
impl Flags for ComplexFlags
Source§const FLAGS: &'static [Flag<ComplexFlags>]
const FLAGS: &'static [Flag<ComplexFlags>]
Source§fn from_bits_retain(bits: u32) -> ComplexFlags
fn from_bits_retain(bits: u32) -> ComplexFlags
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<ComplexFlags> for ComplexFlags
impl FromIterator<ComplexFlags> for ComplexFlags
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 IntoIterator for ComplexFlags
impl IntoIterator for ComplexFlags
Source§impl LowerHex for ComplexFlags
impl LowerHex for ComplexFlags
Source§impl Not for ComplexFlags
impl Not for ComplexFlags
Source§impl Octal for ComplexFlags
impl Octal for ComplexFlags
Source§impl PartialEq for ComplexFlags
impl PartialEq for ComplexFlags
Source§impl PublicFlags for ComplexFlags
impl PublicFlags for ComplexFlags
Source§impl Sub for ComplexFlags
impl Sub for ComplexFlags
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 = ComplexFlags
type Output = ComplexFlags
- operator.Source§impl SubAssign for ComplexFlags
impl SubAssign for ComplexFlags
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.
Source§impl UpperHex for ComplexFlags
impl UpperHex for ComplexFlags
impl Copy for ComplexFlags
impl Eq for ComplexFlags
impl StructuralPartialEq for ComplexFlags
Auto Trait Implementations§
impl Freeze for ComplexFlags
impl RefUnwindSafe for ComplexFlags
impl Send for ComplexFlags
impl Sync for ComplexFlags
impl Unpin for ComplexFlags
impl UnwindSafe for ComplexFlags
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.