foofighters 0.1.0

A lightweight, work-stealing 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

# foofighters

A lightweight, work-stealing thread pool.

[![Crates.io](https://img.shields.io/crates/v/foofighters.svg)](https://crates.io/crates/foofighters)
[![Docs.rs](https://docs.rs/foofighters/badge.svg)](https://docs.rs/foofighters)

## Example

Add this crate using `cargo add foofighters`:

```rust
use foofighters::pool::PoolBuilder;

let pool = PoolBuilder::new()
    .set_worker_count(4)
    .set_steal_amount(2)
    .build();

let submission = pool.spawn(|| {
    println!("Hello from a worker!");
});

submission.into_result().unwrap();
```

## Lifecycle

Each worker thread runs this cycle:

1.  Execute all tasks in its local queue.
2.  Steal from the global queue if empty.
3.  Attempt to steal batches from other workers.
4.  Park when no work remains (and unpark when new tasks arrive).
5.  On shutdown, drain any remaining global tasks before exiting.

## Shutdown

When the `Pool` instance is dropped:

- Task submissions are automatically blocked.
- All worker threads are unparked.
- Each worker drains any remaining global tasks.
- The pool joins all threads before returning control.

## Tests

```bash
cargo test
```

Or just check compilation without running them as running it will spawn threads:

```bash
cargo test --doc --no-run
```

## License

**MIT**