Struct async_utils::event::Event

pub struct Event { /* private fields */ }

An Event is a clonable object that can be signaled once. Calls to .wait() produce a future, EventWait, that can wait on that signal. Once the Event has been signaled, all futures will complete immediately.

Implementations

impl Event

pub fn new() -> Self

Create a new Event that has not yet been signaled.

pub fn signal(&self) -> bool

Signal the Event. Once this is done, it cannot be undone. Any tasks waiting on this Event will be notified and its Future implementation will complete.

Returns true if this Event was the one that performed the signal operation.

pub fn signaled(&self) -> bool

Return true if Event::signal has already been called.

pub fn wait(&self) -> EventWait

Create a new EventWait future that will complete after this event has been signaled. If all signalers are dropped, this future will continue to return Poll::Pending. To be notified when all signalers are dropped without signaling, use wait_or_dropped.

pub fn wait_or_dropped(&self) -> EventWaitResult

Create a new EventWaitResult future that will complete after this event has been signaled or all Event clones have been dropped.

This future will output a Result<(), Dropped> to indicate what has occurred.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.