32 stable releases (4 major)

5.3.1 May 29, 2024
5.2.0 Feb 29, 2024
4.0.3 Jan 6, 2024
4.0.1 Dec 19, 2023
1.2.0 May 25, 2020

#14 in Asynchronous

Download history 1917104/week @ 2024-08-18 1939408/week @ 2024-08-25 1861618/week @ 2024-09-01 1946722/week @ 2024-09-08 1784794/week @ 2024-09-15 2033402/week @ 2024-09-22 1998317/week @ 2024-09-29 2147893/week @ 2024-10-06 2070668/week @ 2024-10-13 2197632/week @ 2024-10-20 2109998/week @ 2024-10-27 2181733/week @ 2024-11-03 2105547/week @ 2024-11-10 2080553/week @ 2024-11-17 1699301/week @ 2024-11-24 1861126/week @ 2024-12-01

7,857,485 downloads per month
Used in 8,796 crates (120 directly)

Apache-2.0 OR MIT

140KB
2.5K SLoC

event-listener

Build License Cargo Documentation

Notify async tasks or threads.

This is a synchronization primitive similar to eventcounts invented by Dmitry Vyukov.

You can use this crate to turn non-blocking data structures into async or blocking data structures. See a simple mutex implementation that exposes an async and a blocking interface for acquiring locks.

Examples

Wait until another thread sets a boolean flag:

use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::thread;
use std::time::Duration;
use event_listener::Event;

let flag = Arc::new(AtomicBool::new(false));
let event = Arc::new(Event::new());

// Spawn a thread that will set the flag after 1 second.
thread::spawn({
    let flag = flag.clone();
    let event = event.clone();
    move || {
        // Wait for a second.
        thread::sleep(Duration::from_secs(1));

        // Set the flag.
        flag.store(true, Ordering::SeqCst);

        // Notify all listeners that the flag has been set.
        event.notify(usize::MAX);
    }
});

// Wait until the flag is set.
loop {
    // Check the flag.
    if flag.load(Ordering::SeqCst) {
        break;
    }

    // Start listening for events.
    let listener = event.listen();

    // Check the flag again after creating the listener.
    if flag.load(Ordering::SeqCst) {
        break;
    }

    // Wait for a notification and continue the loop.
    listener.wait();
}

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.2–24MB
~340K SLoC