Struct ThreadPool

pub struct ThreadPool<WorkerData: Send + 'static = ()> { /* private fields */ }

The Thread Pool struct. This can be constructed using the ThreadPool::new method.

Examples

use lending_thread_pool::ThreadPool;

let mut pool = ThreadPool::new(
	(0..4)
		.map(|i| format!("Hello from worker {i}"))
		.collect::<Vec<_>>(),
);


for _ in 0..16 {
	pool.enqueue(|greeting| { println!("{greeting}"); });
}

Implementations

impl<WorkerData: Send + 'static> ThreadPool<WorkerData>

pub fn new(workers_data: Vec<WorkerData>) -> Self

Construct a thread pool given a Vec of WorkerData. The number of workers will correspond to the length of the Vec, so will the queue size for pending tasks. Note that WorkerData can be any type. Each worker thread will own its corresponding WorkerData.

Panics

• if Vec is empty

Examples

use lending_thread_pool::ThreadPool;

let mut pool = ThreadPool::new(
	(0..4)
		.map(|i| format!("Hello from worker {i}"))
		.collect::<Vec<_>>(),
);


for _ in 0..16 {
	pool.enqueue(|greeting| { println!("{greeting}"); });
}

pub fn new_with_queue_size( workers_data: Vec<WorkerData>, max_pending_tasks: usize, ) -> Self

Construct a thread pool given a Vec of WorkerData. The number of workers will correspond to the length of the Vec. Note that WorkerData can be any type you want. Each worker thread will own its corresponding WorkerData.

Panics

• if Vec is empty
• if max_pending_tasks is 0.

Examples

use lending_thread_pool::ThreadPool;

let mut pool = ThreadPool::new_with_queue_size(
	(0..4)
		.map(|i| format!("Hello from worker {i}"))
		.collect::<Vec<_>>(),
	2,
);


for _ in 0..16 {
	pool.enqueue(|greeting| { println!("{greeting}"); });
}

pub fn enqueue<Task: FnOnce(&mut WorkerData) + Send + 'static>( &mut self, task: Task, )

Enqueue a task in the pool.

Blocking

This method is blocking. It waits for the task queue to have at least one empty slot before returning.

pub fn join(self)

Signal to all worker threads that they should exit once finished with their current task, then joins all their handles.

Note: join is automatically called on drop.

Trait Implementations

impl<WorkerData: Debug + Send + 'static> Debug for ThreadPool<WorkerData>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<WorkerData: Send + 'static> Drop for ThreadPool<WorkerData>

fn drop(&mut self)

Executes the destructor for this type.