Struct EventEmitter

pub struct EventEmitter(Mutex<Receiver<Event>>);

A receiver of events from a Context.

See Context::get_event_emitter to create an instance. If multiple instances are created events emitted by the Context will only be delivered to one of the EventEmitters.

Tuple Fields

0: Mutex<Receiver<Event>>

Implementations

impl EventEmitter

pub async fn recv(&self) -> Option<Event>

Async recv of an event. Return None if the Sender has been dropped.

pub fn try_recv(&self) -> Result<Event>

Tries to receive an event without blocking.

Returns error if no events are available for reception or if receiver mutex is locked by a concurrent call to recv or try_recv.

Trait Implementations

impl Debug for EventEmitter

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

Formats the value using the given formatter.