Struct r3::kernel::event_group::EventGroupRef
source · pub struct EventGroupRef<'a, System>(_, _)
where
System: KernelEventGroup;
Expand description
Represents a single borrowed event group in a system.
This type is ABI-compatible with System::
RawEventGroupId
. It’s
logically equivalent to &'a EventGroup
but instead stores RawEventGroupId
directly.
See EventGroup
for the owned counterpart and the description
of this kernel object.
See EventGroupMethods
for the operations provided by this handle
type.
Implementations§
source§impl<System> EventGroupRef<'static, System>where
System: KernelEventGroup,
impl<System> EventGroupRef<'static, System>where System: KernelEventGroup,
sourcepub const fn define() -> EventGroupDefiner<System>
pub const fn define() -> EventGroupDefiner<System>
Construct a EventGroupDefiner
to define an event group in a
configuration function.
Trait Implementations§
source§impl<System> Clone for EventGroupRef<'_, System>where
System: KernelEventGroup,
impl<System> Clone for EventGroupRef<'_, System>where System: KernelEventGroup,
source§fn clone(&self) -> EventGroupRef<'_, System>
fn clone(&self) -> EventGroupRef<'_, System>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<System> Debug for EventGroupRef<'_, System>where
System: KernelEventGroup,
impl<System> Debug for EventGroupRef<'_, System>where System: KernelEventGroup,
source§impl<System> EventGroupHandle for EventGroupRef<'_, System>where
System: KernelEventGroup,
impl<System> EventGroupHandle for EventGroupRef<'_, System>where System: KernelEventGroup,
source§const unsafe fn from_id(
id: <System as KernelEventGroup>::RawEventGroupId
) -> EventGroupRef<'_, System>
const unsafe fn from_id( id: <System as KernelEventGroup>::RawEventGroupId ) -> EventGroupRef<'_, System>
source§const fn id(&self) -> <System as KernelEventGroup>::RawEventGroupId
const fn id(&self) -> <System as KernelEventGroup>::RawEventGroupId
Get the raw
RawEventGroupId
value representing this object.source§const fn borrow(
&self
) -> EventGroupRef<'_, <EventGroupRef<'_, System> as EventGroupHandle>::System>
const fn borrow( &self ) -> EventGroupRef<'_, <EventGroupRef<'_, System> as EventGroupHandle>::System>
source§impl<System> Hash for EventGroupRef<'_, System>where
System: KernelEventGroup,
impl<System> Hash for EventGroupRef<'_, System>where System: KernelEventGroup,
source§impl<System> PartialEq<EventGroup<System>> for EventGroupRef<'_, System>where
System: NotSupportedYet,
impl<System> PartialEq<EventGroup<System>> for EventGroupRef<'_, System>where System: NotSupportedYet,
source§fn eq(&self, other: &EventGroup<System>) -> bool
fn eq(&self, other: &EventGroup<System>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<System> PartialEq<EventGroupRef<'_, System>> for EventGroup<System>where
System: NotSupportedYet,
impl<System> PartialEq<EventGroupRef<'_, System>> for EventGroup<System>where System: NotSupportedYet,
source§fn eq(&self, other: &EventGroupRef<'_, System>) -> bool
fn eq(&self, other: &EventGroupRef<'_, System>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<System> PartialEq<EventGroupRef<'_, System>> for EventGroupRef<'_, System>where
System: KernelEventGroup,
impl<System> PartialEq<EventGroupRef<'_, System>> for EventGroupRef<'_, System>where System: KernelEventGroup,
source§fn eq(&self, other: &EventGroupRef<'_, System>) -> bool
fn eq(&self, other: &EventGroupRef<'_, System>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl<System> Copy for EventGroupRef<'_, System>where System: KernelEventGroup,
impl<System> Eq for EventGroupRef<'_, System>where System: KernelEventGroup,
Auto Trait Implementations§
impl<'a, System> RefUnwindSafe for EventGroupRef<'a, System>where <System as KernelEventGroup>::RawEventGroupId: RefUnwindSafe,
impl<'a, System> Send for EventGroupRef<'a, System>
impl<'a, System> Sync for EventGroupRef<'a, System>
impl<'a, System> Unpin for EventGroupRef<'a, System>where <System as KernelEventGroup>::RawEventGroupId: Unpin,
impl<'a, System> UnwindSafe for EventGroupRef<'a, System>where <System as KernelEventGroup>::RawEventGroupId: UnwindSafe,
Blanket Implementations§
source§impl<T> EventGroupMethods for Twhere
T: EventGroupHandle,
impl<T> EventGroupMethods for Twhere T: EventGroupHandle,
source§fn wait(
&self,
bits: u32,
flags: EventGroupWaitFlags
) -> Result<u32, WaitEventGroupError>
fn wait( &self, bits: u32, flags: EventGroupWaitFlags ) -> Result<u32, WaitEventGroupError>
Wait for all or any of the specified bits to be set. Optionally, clear
the specified bits. Read more
source§fn wait_timeout(
&self,
bits: u32,
flags: EventGroupWaitFlags,
timeout: Duration
) -> Result<u32, WaitEventGroupTimeoutError>
fn wait_timeout( &self, bits: u32, flags: EventGroupWaitFlags, timeout: Duration ) -> Result<u32, WaitEventGroupTimeoutError>
wait
with timeout.source§fn poll(
&self,
bits: u32,
flags: EventGroupWaitFlags
) -> Result<u32, PollEventGroupError>
fn poll( &self, bits: u32, flags: EventGroupWaitFlags ) -> Result<u32, PollEventGroupError>
Non-blocking version of
wait
. Returns immediately with
PollEventGroupError::Timeout
if the unblocking condition is not
satisfied.