safina-threadpool 0.1.0

Safe thread pool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# safina-threadpool

[![crates.io version](https://img.shields.io/crates/v/safina-threadpool.svg)](https://crates.io/crates/safina-threadpool)
[![license: Apache 2.0](https://gitlab.com/leonhard-llc/safina-rs/-/raw/main/license-apache-2.0.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![unsafe forbidden](https://gitlab.com/leonhard-llc/safina-rs/-/raw/main/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
[![pipeline status](https://gitlab.com/leonhard-llc/safina-rs/badges/main/pipeline.svg)](https://gitlab.com/leonhard-llc/safina-rs/-/pipelines)

This is a safe Rust thread pool library.

It is part of [`safina`](https://crates.io/crates/safina), a safe async runtime.

## Features
- `forbid(unsafe_code)`
- Depends only on `std`
- Good test coverage (100%)

## Limitations
- Allocates memory
- Not optimized

## Documentation
https://docs.rs/safina-threadpool

## Examples
```rust
let pool =
    safina_threadpool::ThreadPool::new("worker", 2);
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
- [blocking](https://crates.io/crates/blocking)
  - Popular
  - A little `unsafe` code
- [threadpool](https://crates.io/crates/threadpool)
  - Popular
  - Well maintained
  - Dependencies have `unsafe` code
- [futures-executor](https://crates.io/crates/futures-executor)
  - Very popular
  - Full of `unsafe`
- [scoped_threadpool](https://crates.io/crates/scoped_threadpool)
  - Popular
  - Contains `unsafe` code
- [scheduled-thread-pool](https://crates.io/crates/scheduled-thread-pool)
  - Used by a popular connection pool library
  - Dependencies have `unsafe` code
- [workerpool](https://crates.io/crates/workerpool)
  - Dependencies have `unsafe` code
- [threads_pool](https://crates.io/crates/threads_pool)
  - Full of `unsafe`
- [thread-pool](https://crates.io/crates/thread-pool)
  - Old
  - Dependencies have `unsafe` code
- [tasque](https://crates.io/crates/tasque)
  - Dependencies have `unsafe` code
- [fast-threadpool](https://crates.io/crates/fast-threadpool)
  - Dependencies have `unsafe` code
- [blocking-permit](https://crates.io/crates/blocking-permit)
  - Full of `unsafe`
- [rayon-core](https://crates.io/crates/rayon-core)
  - Full of `unsafe`

## Changelog
- v0.1.0 - First release

## TO DO
- DONE - Add `schedule` and `try_schedule`
- DONE - Add tests
- DONE - Add docs
- DONE - Publish on crates.io
- 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.

## Release Process
1. Edit `Cargo.toml` and bump version number.
1. Run `./release.sh`

License: Apache-2.0