Struct r3::kernel::EventGroupWaitFlags
source · pub struct EventGroupWaitFlags { /* private fields */ }
Expand description
Options for EventGroup::wait
.
Implementations
sourceimpl EventGroupWaitFlags
impl EventGroupWaitFlags
sourcepub const ALL: EventGroupWaitFlags = Self{ bits: 1 << 0,}
pub const ALL: EventGroupWaitFlags = Self{ bits: 1 << 0,}
Wait for all of the specified bits to be set.
sourcepub const CLEAR: EventGroupWaitFlags = Self{ bits: 1 << 1,}
pub const CLEAR: EventGroupWaitFlags = Self{ bits: 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 unsafe fn from_bits_unchecked(bits: u8) -> EventGroupWaitFlags
pub const unsafe fn from_bits_unchecked(bits: u8) -> EventGroupWaitFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
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
sourceimpl Binary for EventGroupWaitFlags
impl Binary for EventGroupWaitFlags
sourceimpl BitAnd<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitAnd<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn 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.sourceimpl BitAndAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitAndAssign<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn bitand_assign(&mut self, other: EventGroupWaitFlags)
fn bitand_assign(&mut self, other: EventGroupWaitFlags)
Disables all flags disabled in the set.
sourceimpl BitOr<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitOr<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn 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.sourceimpl BitOrAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitOrAssign<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn bitor_assign(&mut self, other: EventGroupWaitFlags)
fn bitor_assign(&mut self, other: EventGroupWaitFlags)
Adds the set of flags.
sourceimpl BitXor<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitXor<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn 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.sourceimpl BitXorAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl BitXorAssign<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn bitxor_assign(&mut self, other: EventGroupWaitFlags)
fn bitxor_assign(&mut self, other: EventGroupWaitFlags)
Toggles the set of flags.
sourceimpl Clone for EventGroupWaitFlags
impl Clone for EventGroupWaitFlags
sourcefn clone(&self) -> EventGroupWaitFlags
fn clone(&self) -> EventGroupWaitFlags
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for EventGroupWaitFlags
impl Debug for EventGroupWaitFlags
sourceimpl Extend<EventGroupWaitFlags> for EventGroupWaitFlags
impl Extend<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EventGroupWaitFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EventGroupWaitFlags>,
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<EventGroupWaitFlags> for EventGroupWaitFlags
impl FromIterator<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn from_iter<T>(iterator: T) -> EventGroupWaitFlagswhere
T: IntoIterator<Item = EventGroupWaitFlags>,
fn from_iter<T>(iterator: T) -> EventGroupWaitFlagswhere
T: IntoIterator<Item = EventGroupWaitFlags>,
sourceimpl Hash for EventGroupWaitFlags
impl Hash for EventGroupWaitFlags
sourceimpl LowerHex for EventGroupWaitFlags
impl LowerHex for EventGroupWaitFlags
sourceimpl Not for EventGroupWaitFlags
impl Not for EventGroupWaitFlags
sourcefn not(self) -> EventGroupWaitFlags
fn not(self) -> EventGroupWaitFlags
Returns the complement of this set of flags.
type Output = EventGroupWaitFlags
type Output = EventGroupWaitFlags
!
operator.sourceimpl Octal for EventGroupWaitFlags
impl Octal for EventGroupWaitFlags
sourceimpl Ord for EventGroupWaitFlags
impl Ord for EventGroupWaitFlags
sourcefn cmp(&self, other: &EventGroupWaitFlags) -> Ordering
fn cmp(&self, other: &EventGroupWaitFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialEq<EventGroupWaitFlags> for EventGroupWaitFlags
impl PartialEq<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn eq(&self, other: &EventGroupWaitFlags) -> bool
fn eq(&self, other: &EventGroupWaitFlags) -> bool
sourceimpl PartialOrd<EventGroupWaitFlags> for EventGroupWaitFlags
impl PartialOrd<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn partial_cmp(&self, other: &EventGroupWaitFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &EventGroupWaitFlags) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<EventGroupWaitFlags> for EventGroupWaitFlags
impl Sub<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn 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.sourceimpl SubAssign<EventGroupWaitFlags> for EventGroupWaitFlags
impl SubAssign<EventGroupWaitFlags> for EventGroupWaitFlags
sourcefn sub_assign(&mut self, other: EventGroupWaitFlags)
fn sub_assign(&mut self, other: EventGroupWaitFlags)
Disables all flags enabled in the set.