Struct r3_core::kernel::event_group::EventGroupRef
source · #[repr(transparent)]pub struct EventGroupRef<'a, 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
sourceimpl<System: KernelEventGroup> EventGroupRef<'static, System>
impl<System: KernelEventGroup> EventGroupRef<'static, System>
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
sourceimpl<System: KernelEventGroup> Clone for EventGroupRef<'_, System>
impl<System: KernelEventGroup> Clone for EventGroupRef<'_, System>
sourceimpl<System: KernelEventGroup> Debug for EventGroupRef<'_, System>
impl<System: KernelEventGroup> Debug for EventGroupRef<'_, System>
sourceimpl<System: KernelEventGroup> EventGroupHandle for EventGroupRef<'_, System>
impl<System: KernelEventGroup> EventGroupHandle for EventGroupRef<'_, 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: KernelEventGroup> Hash for EventGroupRef<'_, System>
impl<System: KernelEventGroup> Hash for EventGroupRef<'_, 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
sourceimpl<System: KernelEventGroup> PartialEq<EventGroupRef<'_, System>> for EventGroupRef<'_, System>
impl<System: KernelEventGroup> PartialEq<EventGroupRef<'_, System>> for EventGroupRef<'_, System>
impl<System: KernelEventGroup> Copy for EventGroupRef<'_, System>
impl<System: KernelEventGroup> Eq for EventGroupRef<'_, System>
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
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