Struct sunrise_libuser::types::ReadableEvent

#[repr(transparent)]pub struct ReadableEvent(pub Handle);

The readable part of an event. The user shall use this end to verify if the event is signaled, and wait for the signaling through wait_synchronization. The user can also use this handle to clear the signaled state through ReadableEvent::clear().

Implementations

impl ReadableEvent

pub fn clear(&self) -> Result<(), KernelError>

Clears the signaled state.

pub fn wait_async(
    &self,
    queue: WorkQueue
) -> impl Future<Output = Result<(), Error>> + Unpin

Waits for the event to get signaled.

Note: This function is a bit of a footgun. If you intend to have multiple futures wait on the same event (to use it like a semaphore), please look at ReadableEvent::wait_async_cb() instead.

Panics

Panics if used from outside the context of a Future spawned on a libuser future executor. Please make sure you only call this function from a future spawned on a WaitableManager.

pub fn wait_async_cb<F, T>(
    &self,
    queue: WorkQueue,
    f: F
) -> impl Future<Output = T> + Unpin where
    F: FnMut() -> Option<T> + Unpin, 

Turns this ReadableEvent into a semaphore-like structure.

This function will repeatedly run f when the event is triggered, until it returns true. When it returns false, the future will first clear the event before waiting on it.

Panics

Panics if used from outside the context of a Future spawned on a libuser future executor. Please make sure you only call this function from a future spawned on a WaitableManager.

Trait Implementations

impl Debug for ReadableEvent

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.