Struct r3_core::kernel::event_group::EventGroup
source · #[repr(transparent)]pub struct EventGroup<System: NotSupportedYet>(_);
Expand description
Represents a single owned event group in a system.
This type is ABI-compatible with System::
RawEventGroupId
.
See EventGroupRef
for the borrowed counterpart.
See EventGroupMethods
for the operations provided by this handle
type.
An event group is a set of bits that can be updated and waited for to be set.
Relation to Other Specifications: event group (FreeRTOS), event group (Freescale MQX),
EventFlags
(Mbed OS), events (OSEK/VDX, assigned to each extended task), event (RT-Thread), event set (RTEMS, assigned to each task), Eventflag (μITRON4.0)
Trait Implementations
sourceimpl<System: NotSupportedYet> Debug for EventGroup<System>
impl<System: NotSupportedYet> Debug for EventGroup<System>
sourceimpl<System: NotSupportedYet> EventGroupHandle for EventGroup<System>
impl<System: NotSupportedYet> EventGroupHandle for EventGroup<System>
type System = System
type System = System
The system type this object pertains to.
sourceconst unsafe fn from_id(
id: <System as KernelEventGroup>::RawEventGroupId
) -> Self
const unsafe fn from_id(
id: <System as KernelEventGroup>::RawEventGroupId
) -> Self
sourceconst fn id(&self) -> System::RawEventGroupId
const fn id(&self) -> System::RawEventGroupId
Get the raw
RawEventGroupId
value representing this object.sourceconst fn borrow(&self) -> EventGroupRef<'_, Self::System>
const fn borrow(&self) -> EventGroupRef<'_, Self::System>
sourceimpl<System: NotSupportedYet> Hash for EventGroup<System>
impl<System: NotSupportedYet> Hash for EventGroup<System>
sourceimpl<System: NotSupportedYet> PartialEq<EventGroup<System>> for EventGroup<System>
impl<System: NotSupportedYet> PartialEq<EventGroup<System>> for EventGroup<System>
sourceimpl<System: NotSupportedYet> PartialEq<EventGroup<System>> for EventGroupRef<'_, System>
impl<System: NotSupportedYet> PartialEq<EventGroup<System>> for EventGroupRef<'_, System>
sourcefn eq(&self, other: &EventGroup<System>) -> bool
fn eq(&self, other: &EventGroup<System>) -> bool
sourceimpl<System: NotSupportedYet> PartialEq<EventGroupRef<'_, System>> for EventGroup<System>
impl<System: NotSupportedYet> PartialEq<EventGroupRef<'_, System>> for EventGroup<System>
sourcefn eq(&self, other: &EventGroupRef<'_, System>) -> bool
fn eq(&self, other: &EventGroupRef<'_, System>) -> bool
impl<System: NotSupportedYet> Eq for EventGroup<System>
Auto Trait Implementations
impl<System> RefUnwindSafe for EventGroup<System>where
<System as KernelEventGroup>::RawEventGroupId: RefUnwindSafe,
impl<System> Send for EventGroup<System>
impl<System> Sync for EventGroup<System>
impl<System> Unpin for EventGroup<System>where
<System as KernelEventGroup>::RawEventGroupId: Unpin,
impl<System> UnwindSafe for EventGroup<System>where
<System as KernelEventGroup>::RawEventGroupId: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> EventGroupMethods for Twhere
T: EventGroupHandle,
impl<T> EventGroupMethods for Twhere
T: EventGroupHandle,
sourcefn set(&self, bits: EventGroupBits) -> Result<(), UpdateEventGroupError>
fn set(&self, bits: EventGroupBits) -> Result<(), UpdateEventGroupError>
Set the specified bits.
sourcefn clear(&self, bits: EventGroupBits) -> Result<(), UpdateEventGroupError>
fn clear(&self, bits: EventGroupBits) -> Result<(), UpdateEventGroupError>
Clear the specified bits.
sourcefn get(&self) -> Result<EventGroupBits, GetEventGroupError>
fn get(&self) -> Result<EventGroupBits, GetEventGroupError>
Get the currently set bits.
sourcefn wait(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags
) -> Result<EventGroupBits, WaitEventGroupError>
fn wait(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags
) -> Result<EventGroupBits, WaitEventGroupError>
Wait for all or any of the specified bits to be set. Optionally, clear
the specified bits. Read more
sourcefn wait_timeout(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags,
timeout: Duration
) -> Result<EventGroupBits, WaitEventGroupTimeoutError>
fn wait_timeout(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags,
timeout: Duration
) -> Result<EventGroupBits, WaitEventGroupTimeoutError>
wait
with timeout.sourcefn poll(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags
) -> Result<EventGroupBits, PollEventGroupError>
fn poll(
&self,
bits: EventGroupBits,
flags: EventGroupWaitFlags
) -> Result<EventGroupBits, PollEventGroupError>
Non-blocking version of
wait
. Returns immediately with
PollEventGroupError::Timeout
if the unblocking condition is not
satisfied. Read more