pub struct EventListener { /* 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.

Implementations

Blocks until a notification is received.

Examples
use event_listener::Event;

let event = Event::new();
let listener = event.listen();

// Notify `listener`.
event.notify(1);

// Receive the notification.
listener.wait();

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

Returns true if a notification was received.

Examples
use std::time::Duration;
use event_listener::Event;

let event = Event::new();
let listener = event.listen();

// There are no notification so this times out.
assert!(!listener.wait_timeout(Duration::from_secs(1)));

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

Returns true if a notification was received.

Examples
use std::time::{Duration, Instant};
use event_listener::Event;

let event = Event::new();
let listener = event.listen();

// There are no notification so this times out.
assert!(!listener.wait_deadline(Instant::now() + Duration::from_secs(1)));

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

Returns true if a notification was discarded.

Examples
use event_listener::Event;

let event = Event::new();
let listener1 = event.listen();
let listener2 = event.listen();

event.notify(1);

assert!(listener1.discard());
assert!(!listener2.discard());

Returns true if this listener listens to the given Event.

Examples
use event_listener::Event;

let event = Event::new();
let listener = event.listen();

assert!(listener.listens_to(&event));

Returns true if both listeners listen to the same Event.

Examples
use event_listener::Event;

let event = Event::new();
let listener1 = event.listen();
let listener2 = event.listen();

assert!(listener1.same_event(&listener2));

Trait Implementations

Formats the value using the given formatter. Read more

Executes the destructor for this type. Read more

The type of value produced on completion.

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.