safina-threadpool

Crates.iosafina-threadpool
lib.rssafina-threadpool
version0.2.5
sourcesrc
created_at2020-12-19 05:09:33.296949
updated_at2024-10-27 23:34:59.537182
descriptionSafe thread pool - ARCHIVED: Code moved to `safina` crate.
homepage
repositoryhttps://gitlab.com/leonhard-llc/safina-rs
max_upload_size
id324518
size44,059
Michael Leonhard (mleonhard)

documentation

README

ARCHIVED ARCHIVED ARCHIVED

This crate is archived and will not be updated.

The code is now at safina::threadpool in the safina crate.


safina-threadpool

A threadpool.

You can use it alone or with safina, a safe async runtime.

Features

  • Add a closure or FnOnce to the pool and one of the threads will execute it
  • Automatically restarts panicked threads
  • Retries after failing to spawn a thread
  • Drop the ThreadPool struct to stop all idle threads.
  • Destroy the pool and wait for all threads to stop
  • forbid(unsafe_code)
  • Depends only on std
  • 100% test coverage

Limitations

  • Not optimized

Examples

let pool =
    safina_threadpool::ThreadPool::new("worker", 2).unwrap();
let receiver = {
    let (sender, receiver) =
        std::sync::mpsc::channel();
    for data in data_source {
        let sender_clone = sender.clone();
        pool.schedule(
            move || process_data(data, sender_clone));
    }
    receiver
};
let results: Vec<ProcessResult> =
    receiver.iter().collect();
// ...

Alternatives

Changelog

Changelog
  • v0.2.4 - Update docs.
  • v0.2.3 - Implement From<NewThreadPoolError> and From<TryScheduleError> for std::io::Error.
  • v0.2.2 - Add ThreadPool::join and ThreadPool::try_join.
  • v0.2.1 - Improve test coverage.
  • v0.2.0
    • ThreadPool::new to return Result.
    • ThreadPool::try_schedule to return an error when it fails to restart panicked threads.
    • ThreadPool::schedule to handle failure starting replacement threads.
  • v0.1.4 - Stop threads on drop.
  • v0.1.3 - Support stable Rust! Needs 1.51+.
  • v0.1.2 - Add another example
  • v0.1.1 - Simplified internals and improved documentation.
  • v0.1.0 - First release

TO DO

  • Make join and try_join work with Arc<ThreadPool>.
  • Log a warning when all threads panicked.
  • Update test coverage.
  • Add a public respawn_threads function.
  • Add a stress test
  • Add a benchmark. See benchmarks in https://crates.io/crates/executors
  • Add a way for a job to schedule another job on the same thread, with stealing.
Commit count: 379

cargo fmt