Struct EventListener

pub struct EventListener<T = ()> { /* private fields */ }

A guard waiting for a notification from an Event.

There are two ways for a listener to wait for a notification:

1. In an asynchronous manner using .await.
2. In a blocking manner by calling EventListener::wait() on it.

If a notified listener is dropped without receiving a notification, dropping will notify another active listener. Whether one additional listener will be notified depends on what kind of notification was delivered.

See the Listener trait for the functionality exposed by this type.

This structure allocates the listener on the heap.

Trait Implementations

impl<T> Debug for EventListener<T>

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

Formats the value using the given formatter.

impl<T> Future for EventListener<T>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T> Listener<T> for EventListener<T>

fn wait(self) -> T

Blocks until a notification is received.

fn wait_timeout(self, timeout: Duration) -> Option<T>

Blocks until a notification is received or a timeout is reached.

fn wait_deadline(self, deadline: Instant) -> Option<T>

Blocks until a notification is received or a deadline is reached.

fn discard(self) -> bool

Drops this listener and discards its notification (if any) without notifying another active listener.

fn listens_to(&self, event: &Event<T>) -> bool

Returns true if this listener listens to the given Event.

fn same_event(&self, other: &EventListener<T>) -> bool

Returns true if both listeners listen to the same Event.

impl<T> RefUnwindSafe for EventListener<T>

impl<T: Send> Send for EventListener<T>

impl<T: Send> Sync for EventListener<T>

impl<T> Unpin for EventListener<T>

impl<T> UnwindSafe for EventListener<T>