Struct event_listener::EventListener

source ·
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§

source§

impl EventListener

source

pub fn wait(self)

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();
source

pub fn wait_timeout(self, timeout: Duration) -> bool

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)));
source

pub fn wait_deadline(self, deadline: Instant) -> bool

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)));
source

pub fn discard(self) -> bool

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());
source

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

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));
source

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

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§

source§

impl Debug for EventListener

source§

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

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

impl Drop for EventListener

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Future for EventListener

source§

type Output = ()

The type of value produced on completion.
source§

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

Attempts 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 RefUnwindSafe for EventListener

source§

impl Send for EventListener

source§

impl Sync for EventListener

source§

impl UnwindSafe for EventListener

Auto Trait Implementations§

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,

source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
source§

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>,

source§

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>,

source§

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.