pub struct TypeMask(/* private fields */);
Implementations§
§impl TypeMask
impl TypeMask
pub 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.
pub const fn from_bits(bits: u32) -> Option<TypeMask>
pub const fn from_bits(bits: u32) -> Option<TypeMask>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u32) -> TypeMask
pub const fn from_bits_truncate(bits: u32) -> TypeMask
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u32) -> TypeMask
pub const fn from_bits_retain(bits: u32) -> TypeMask
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<TypeMask>
pub fn from_name(name: &str) -> Option<TypeMask>
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.
pub const fn intersects(&self, other: TypeMask) -> bool
pub const fn intersects(&self, other: TypeMask) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: TypeMask) -> bool
pub const fn contains(&self, other: TypeMask) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn remove(&mut self, other: TypeMask)
pub fn remove(&mut self, other: TypeMask)
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.
pub fn toggle(&mut self, other: TypeMask)
pub fn toggle(&mut self, other: TypeMask)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: TypeMask, value: bool)
pub fn set(&mut self, other: TypeMask, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: TypeMask) -> TypeMask
pub const fn intersection(self, other: TypeMask) -> TypeMask
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: TypeMask) -> TypeMask
pub const fn union(self, other: TypeMask) -> TypeMask
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: TypeMask) -> TypeMask
pub const fn difference(self, other: TypeMask) -> TypeMask
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.
pub const fn symmetric_difference(self, other: TypeMask) -> TypeMask
pub const fn symmetric_difference(self, other: TypeMask) -> TypeMask
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> TypeMask
pub const fn complement(self) -> TypeMask
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl TypeMask
impl TypeMask
pub const fn iter(&self) -> Iter<TypeMask>
pub const fn iter(&self) -> Iter<TypeMask>
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.
pub const fn iter_names(&self) -> IterNames<TypeMask>
pub const fn iter_names(&self) -> IterNames<TypeMask>
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§
§impl BitAndAssign for TypeMask
impl BitAndAssign for TypeMask
§fn bitand_assign(&mut self, other: TypeMask)
fn bitand_assign(&mut self, other: TypeMask)
The bitwise and (&
) of the bits in two flags values.
§impl BitOrAssign for TypeMask
impl BitOrAssign for TypeMask
§fn bitor_assign(&mut self, other: TypeMask)
fn bitor_assign(&mut self, other: TypeMask)
The bitwise or (|
) of the bits in two flags values.
§impl BitXorAssign for TypeMask
impl BitXorAssign for TypeMask
§fn bitxor_assign(&mut self, other: TypeMask)
fn bitxor_assign(&mut self, other: TypeMask)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Extend<TypeMask> for TypeMask
impl Extend<TypeMask> for TypeMask
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = TypeMask>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = TypeMask>,
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
)§impl Flags for TypeMask
impl Flags for TypeMask
§fn from_bits_retain(bits: u32) -> TypeMask
fn from_bits_retain(bits: u32) -> TypeMask
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§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.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§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.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl FromIterator<TypeMask> for TypeMask
impl FromIterator<TypeMask> for TypeMask
§fn from_iter<T>(iterator: T) -> TypeMaskwhere
T: IntoIterator<Item = TypeMask>,
fn from_iter<T>(iterator: T) -> TypeMaskwhere
T: IntoIterator<Item = TypeMask>,
The bitwise or (|
) of the bits in each flags value.
§impl IntoIterator for TypeMask
impl IntoIterator for TypeMask
§impl Ord for TypeMask
impl Ord for TypeMask
§impl PartialOrd for TypeMask
impl PartialOrd for TypeMask
§impl Sub for TypeMask
impl Sub for TypeMask
§impl SubAssign for TypeMask
impl SubAssign for TypeMask
§fn sub_assign(&mut self, other: TypeMask)
fn sub_assign(&mut self, other: TypeMask)
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.
impl Copy for TypeMask
impl Eq for TypeMask
impl StructuralPartialEq for TypeMask
Auto Trait Implementations§
impl Freeze for TypeMask
impl RefUnwindSafe for TypeMask
impl Send for TypeMask
impl Sync for TypeMask
impl Unpin for TypeMask
impl UnwindSafe for TypeMask
Blanket Implementations§
§impl<T> AnyEq for T
impl<T> AnyEq for T
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.