task_pool
offers a flexible abstraction for composing and distributing work within a fixed hardware threadpool. To that end, it offers the following features:
To use task_pool
, there are three steps:
WorkProvider
instances (such as a queue or chain of multiple queues)TaskPool
which consumes those instancesWorkProvider
s which are handled by the threadpoolThe following example shows these steps in action:
```rust
// 1. Create a queue from which we can spawn tasks
let queue = TaskQueue::
// 2. Create a threadpool that draws from the provided queue. Forget the threadpool so that it runs indefinitely. TaskPool::new(queue.clone(), 4).forget();
// 3. Spawn a task into the queue and synchronously await its completion. assert_eq!(queue.spawn(once(|| { println!("This will execute on background thread."); 2 })).join(), 2);
// ...or, asynchronously await its completion. assert_eq!(queue.spawn(once(|| { println!("This will execute on background thread."); 2 })).await, 2); ```