#thread #stoppable #stopped #stop #sync #interface #atomic-bool

stoppable_thread

A wrapper for thread that allows it to be easily stopped cooperatively

7 releases

Uses old Rust 2015

0.2.1 May 6, 2016
0.2.0 May 6, 2016
0.1.4 Mar 12, 2016

#790 in Concurrency

Download history 336/week @ 2024-08-26 294/week @ 2024-09-02 301/week @ 2024-09-09 236/week @ 2024-09-16 313/week @ 2024-09-23 227/week @ 2024-09-30 458/week @ 2024-10-07 336/week @ 2024-10-14 244/week @ 2024-10-21 230/week @ 2024-10-28 132/week @ 2024-11-04 152/week @ 2024-11-11 144/week @ 2024-11-18 150/week @ 2024-11-25 141/week @ 2024-12-02 302/week @ 2024-12-09

746 downloads per month
Used in 5 crates (4 directly)

MIT license

7KB
138 lines

A stoppable, thin wrapper around std::Thread.

Uses std::sync::atomic::AtomicBool and std::thread to create stoppable threads.

The interface is very similar to that of std::thread::Thread (or rather std::thread::JoinHandle) except that every closure passed in must accept a stopped parameter, allowing to check whether or not a stop was requested.

Since all stops must have gracefully, i.e. by requesting the child thread to stop, partial values can be returned if needed.

Example:

use stoppable_thread;

let handle = stoppable_thread::spawn(|stopped| {
    let mut count: u64 = 0;

    while !stopped.get() {
        count += 1
    }

    count
});

// work in main thread

// stop the thread. we also want to collect partial results
let child_count = handle.stop().join().unwrap();

No runtime deps