#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

#794 in Concurrency

Download history 371/week @ 2024-07-26 288/week @ 2024-08-02 208/week @ 2024-08-09 440/week @ 2024-08-16 277/week @ 2024-08-23 353/week @ 2024-08-30 275/week @ 2024-09-06 263/week @ 2024-09-13 252/week @ 2024-09-20 276/week @ 2024-09-27 439/week @ 2024-10-04 355/week @ 2024-10-11 279/week @ 2024-10-18 200/week @ 2024-10-25 166/week @ 2024-11-01 98/week @ 2024-11-08

821 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