Struct Event

pub struct Event { /* private fields */ }

An object that can receive or send notifications.

Implementations

impl Event

pub fn new() -> Self

Creates a new event.

pub fn notify(&self, n: usize)

Notify a number of awaiting events that the predicate should be checked.

If less events than requested are currently awaiting, then all awaiting event are notified.

pub fn notify_one(&self)

Notify one awaiting event (if any) that the predicate should be checked.

pub fn notify_all(&self)

Notify all awaiting events that the predicate should be checked.

pub fn wait_until<F, T>(&self, predicate: F) -> WaitUntil<'_, F, T>

where F: FnMut() -> Option<T>,

Returns a future that can be awaited until the provided predicate is satisfied.

pub fn wait_until_or_timeout<F, T, D>( &self, predicate: F, deadline: D, ) -> WaitUntilOrTimeout<'_, F, T, D>

where F: FnMut() -> Option<T>, D: Future<Output = ()>,

Returns a future that can be awaited until the provided predicate is satisfied or until the provided future completes.

The deadline is specified as a Future that is expected to resolves to () after some duration, such as a tokio::time::Sleep future.

Trait Implementations

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl Send for Event

impl Sync for Event