Struct LocalEvent 

pub struct LocalEvent(/* private fields */);

An event for usage within local runtimess. It is !Send and !Sync.

Trait Implementations

impl Default for LocalEvent

fn default() -> Self

Returns the “default value” for a type.

impl<'a> EventSetter<'a> for LocalEvent

type Waiter = LocalEventAwait<'a>

The future representing a pending acquisition of the event.

fn new() -> Self

Creates a new event in the unset state. This is the expected mode of operation for most events, and means that if a task begins waiting, they will wait until the event is set.

fn new_set() -> Self

Creates an event in the set state. This means that the event can be immediately acquired.

fn wait(&'a self) -> LocalEventAwait<'a>

Waits on the event. This returns a future which when polled will wait for the event to be acquired.

fn try_wait(&self) -> bool

Will try to immediately acquire the event along the fast path. This method is non-blocking and will return true if we could acquire the event, and false if we cannot. This will clear the set flag.

fn set_one(&self) -> bool

Sets the event. This will wake up any events from the queue if any are pending. This returns a boolean if we were able to actually wake up an event or not.

fn set_all<F: FnMut()>(&self, functor: F)

Sets the event and wakes up all events from the queue if they are pending with the functor. This functor allows more advanced book-keeping per event, for instance with counted events.

fn has_waiters(&self) -> bool

If the event has any pending waiters.