Struct r3::kernel::event_group::EventGroupWaitFlags
source · pub struct EventGroupWaitFlags(_);
Expand description
Options for EventGroup::wait
.
Implementations§
source§impl EventGroupWaitFlags
impl EventGroupWaitFlags
sourcepub const ALL: EventGroupWaitFlags = Self::from_bits_retain(1 << 0)
pub const ALL: EventGroupWaitFlags = Self::from_bits_retain(1 << 0)
Wait for all of the specified bits to be set.
sourcepub const CLEAR: EventGroupWaitFlags = Self::from_bits_retain(1 << 1)
pub const CLEAR: EventGroupWaitFlags = Self::from_bits_retain(1 << 1)
Clear the specified bits after waiting for them.
sourcepub const fn empty() -> EventGroupWaitFlags
pub const fn empty() -> EventGroupWaitFlags
Returns an empty set of flags.
sourcepub const fn all() -> EventGroupWaitFlags
pub const fn all() -> EventGroupWaitFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<EventGroupWaitFlags>
pub const fn from_bits(bits: u8) -> Option<EventGroupWaitFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> EventGroupWaitFlags
pub const fn from_bits_truncate(bits: u8) -> EventGroupWaitFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> EventGroupWaitFlags
pub const fn from_bits_retain(bits: u8) -> EventGroupWaitFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<EventGroupWaitFlags>
pub fn from_name(name: &str) -> Option<EventGroupWaitFlags>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn iter_names(&self) -> IterRaw
pub const fn iter_names(&self) -> IterRaw
Iterate over enabled flag values with their stringified names.
sourcepub const fn intersects(&self, other: EventGroupWaitFlags) -> bool
pub const fn intersects(&self, other: EventGroupWaitFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: EventGroupWaitFlags) -> bool
pub const fn contains(&self, other: EventGroupWaitFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: EventGroupWaitFlags)
pub fn insert(&mut self, other: EventGroupWaitFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: EventGroupWaitFlags)
pub fn remove(&mut self, other: EventGroupWaitFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: EventGroupWaitFlags)
pub fn toggle(&mut self, other: EventGroupWaitFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: EventGroupWaitFlags, value: bool)
pub fn set(&mut self, other: EventGroupWaitFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(
self,
other: EventGroupWaitFlags
) -> EventGroupWaitFlags
pub const fn intersection( self, other: EventGroupWaitFlags ) -> EventGroupWaitFlags
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
pub const fn union(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
pub const fn difference(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(
self,
other: EventGroupWaitFlags
) -> EventGroupWaitFlags
pub const fn symmetric_difference( self, other: EventGroupWaitFlags ) -> EventGroupWaitFlags
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> EventGroupWaitFlags
pub const fn complement(self) -> EventGroupWaitFlags
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for EventGroupWaitFlags
impl Binary for EventGroupWaitFlags
source§impl BitAnd<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitAnd<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitand(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
fn bitand(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the intersection between the two sets of flags.
§type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
&
operator.source§impl BitAndAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitAndAssign<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitand_assign(&mut self, other: EventGroupWaitFlags)
fn bitand_assign(&mut self, other: EventGroupWaitFlags)
Disables all flags disabled in the set.
source§impl BitFlags for EventGroupWaitFlags
impl BitFlags for EventGroupWaitFlags
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn empty() -> EventGroupWaitFlags
fn empty() -> EventGroupWaitFlags
source§fn all() -> EventGroupWaitFlags
fn all() -> EventGroupWaitFlags
source§fn from_bits(bits: u8) -> Option<EventGroupWaitFlags>
fn from_bits(bits: u8) -> Option<EventGroupWaitFlags>
source§fn from_bits_truncate(bits: u8) -> EventGroupWaitFlags
fn from_bits_truncate(bits: u8) -> EventGroupWaitFlags
source§fn from_bits_retain(bits: u8) -> EventGroupWaitFlags
fn from_bits_retain(bits: u8) -> EventGroupWaitFlags
source§fn iter_names(&self) -> <EventGroupWaitFlags as BitFlags>::IterNames
fn iter_names(&self) -> <EventGroupWaitFlags as BitFlags>::IterNames
source§fn intersects(&self, other: EventGroupWaitFlags) -> bool
fn intersects(&self, other: EventGroupWaitFlags) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: EventGroupWaitFlags) -> bool
fn contains(&self, other: EventGroupWaitFlags) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: EventGroupWaitFlags)
fn insert(&mut self, other: EventGroupWaitFlags)
source§fn remove(&mut self, other: EventGroupWaitFlags)
fn remove(&mut self, other: EventGroupWaitFlags)
source§fn toggle(&mut self, other: EventGroupWaitFlags)
fn toggle(&mut self, other: EventGroupWaitFlags)
source§fn set(&mut self, other: EventGroupWaitFlags, value: bool)
fn set(&mut self, other: EventGroupWaitFlags, value: bool)
source§impl BitOr<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitOr<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitor(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
fn bitor(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the union of the two sets of flags.
§type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
|
operator.source§impl BitOrAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitOrAssign<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitor_assign(&mut self, other: EventGroupWaitFlags)
fn bitor_assign(&mut self, other: EventGroupWaitFlags)
Adds the set of flags.
source§impl BitXor<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitXor<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitxor(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
fn bitxor(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the left flags, but with all the right flags toggled.
§type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
^
operator.source§impl BitXorAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitXorAssign<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn bitxor_assign(&mut self, other: EventGroupWaitFlags)
fn bitxor_assign(&mut self, other: EventGroupWaitFlags)
Toggles the set of flags.
source§impl Clone for EventGroupWaitFlags
impl Clone for EventGroupWaitFlags
source§fn clone(&self) -> EventGroupWaitFlags
fn clone(&self) -> EventGroupWaitFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for EventGroupWaitFlags
impl Debug for EventGroupWaitFlags
source§impl Extend<EventGroupWaitFlags> for EventGroupWaitFlags
impl Extend<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EventGroupWaitFlags>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = EventGroupWaitFlags>,
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 FromIterator<EventGroupWaitFlags> for EventGroupWaitFlags
impl FromIterator<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn from_iter<T>(iterator: T) -> EventGroupWaitFlagswhere
T: IntoIterator<Item = EventGroupWaitFlags>,
fn from_iter<T>(iterator: T) -> EventGroupWaitFlagswhere T: IntoIterator<Item = EventGroupWaitFlags>,
source§impl Hash for EventGroupWaitFlags
impl Hash for EventGroupWaitFlags
source§impl IntoIterator for EventGroupWaitFlags
impl IntoIterator for EventGroupWaitFlags
§type Item = EventGroupWaitFlags
type Item = EventGroupWaitFlags
source§fn into_iter(self) -> <EventGroupWaitFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <EventGroupWaitFlags as IntoIterator>::IntoIter
source§impl LowerHex for EventGroupWaitFlags
impl LowerHex for EventGroupWaitFlags
source§impl Not for EventGroupWaitFlags
impl Not for EventGroupWaitFlags
source§fn not(self) -> EventGroupWaitFlags
fn not(self) -> EventGroupWaitFlags
Returns the complement of this set of flags.
§type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
!
operator.source§impl Octal for EventGroupWaitFlags
impl Octal for EventGroupWaitFlags
source§impl Ord for EventGroupWaitFlags
impl Ord for EventGroupWaitFlags
source§fn cmp(&self, other: &EventGroupWaitFlags) -> Ordering
fn cmp(&self, other: &EventGroupWaitFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<EventGroupWaitFlags> for EventGroupWaitFlags
impl PartialEq<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn eq(&self, other: &EventGroupWaitFlags) -> bool
fn eq(&self, other: &EventGroupWaitFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<EventGroupWaitFlags> for EventGroupWaitFlags
impl PartialOrd<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn partial_cmp(&self, other: &EventGroupWaitFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &EventGroupWaitFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<EventGroupWaitFlags> for EventGroupWaitFlags
impl Sub<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn sub(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
fn sub(self, other: EventGroupWaitFlags) -> EventGroupWaitFlags
Returns the set difference of the two sets of flags.
§type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
-
operator.source§impl SubAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl SubAssign<EventGroupWaitFlags> for EventGroupWaitFlags
source§fn sub_assign(&mut self, other: EventGroupWaitFlags)
fn sub_assign(&mut self, other: EventGroupWaitFlags)
Disables all flags enabled in the set.