Struct event_listener::EventListener

source ·
pub struct EventListener<T = ()> { /* private fields */ }
Expand description

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§

source§

impl<T> Debug for EventListener<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Future for EventListener<T>

§

type Output = T

The type of value produced on completion.
source§

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

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
source§

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

source§

fn wait(self) -> T

Blocks until a notification is received. Read more
source§

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

Blocks until a notification is received or a timeout is reached. Read more
source§

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

Blocks until a notification is received or a deadline is reached. Read more
source§

fn discard(self) -> bool

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

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

Returns true if this listener listens to the given Event. Read more
source§

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

Returns true if both listeners listen to the same Event. Read more
source§

impl<T> RefUnwindSafe for EventListener<T>

source§

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

source§

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

source§

impl<T> Unpin for EventListener<T>

source§

impl<T> UnwindSafe for EventListener<T>

Auto Trait Implementations§

§

impl<T> Freeze for EventListener<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<F> IntoFuture for F
where F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.