9 unstable releases

0.5.4 Mar 27, 2025
0.5.3 Nov 30, 2024
0.5.2 Apr 27, 2024
0.5.1 Mar 30, 2024
0.4.0 Nov 21, 2023

#1134 in Asynchronous

Download history 662164/week @ 2024-12-19 439398/week @ 2024-12-26 951531/week @ 2025-01-02 1245500/week @ 2025-01-09 1111100/week @ 2025-01-16 1216701/week @ 2025-01-23 1294089/week @ 2025-01-30 1453431/week @ 2025-02-06 1327980/week @ 2025-02-13 1458048/week @ 2025-02-20 1562314/week @ 2025-02-27 1911972/week @ 2025-03-06 1789637/week @ 2025-03-13 2445762/week @ 2025-03-20 1635744/week @ 2025-03-27 1673061/week @ 2025-04-03

7,908,856 downloads per month
Used in 6,433 crates (8 directly)

Apache-2.0 OR MIT

23KB
302 lines

event-listener-strategy

Build License Cargo Documentation

A strategy for using the event-listener crate in both blocking and non-blocking contexts.

One of the stand-out features of the event-listener crate is the ability to use it in both asynchronous and synchronous contexts. However, sometimes using it like this causes a lot of boilerplate to be duplicated. This crate aims to reduce that boilerplate by providing an EventListenerFuture trait that implements both blocking and non-blocking functionality.

Examples

use event_listener::{Event, EventListener};
use event_listener_strategy::{EventListenerFuture, FutureWrapper, Strategy};

use std::pin::Pin;
use std::task::Poll;
use std::thread;
use std::sync::Arc;

// A future that waits three seconds for an event to be fired.
fn wait_three_seconds() -> WaitThreeSeconds {
    let event = Event::new();
    let listener = event.listen();

    thread::spawn(move || {
        thread::sleep(std::time::Duration::from_secs(3));
        event.notify(1);
    });

    WaitThreeSeconds { listener }
}

struct WaitThreeSeconds {
    listener: Pin<Box<EventListener>>,
}

impl EventListenerFuture for WaitThreeSeconds {
    type Output = ();

    fn poll_with_strategy<'a, S: Strategy<'a>>(
        mut self: Pin<&'a mut Self>,
        strategy: &mut S,
        context: &mut S::Context,
    ) -> Poll<Self::Output> {
        strategy.poll(self.listener.as_mut(), context)
    }
}

// Use the future in a blocking context.
let future = wait_three_seconds();
future.wait();

// Use the future in a non-blocking context.
futures_lite::future::block_on(async {
    let future = FutureWrapper::new(wait_three_seconds());
    future.await;
});

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.3–23MB
~298K SLoC