Struct ThreadPool 

pub struct ThreadPool<Job, Result>
where
    Job: Send,
    Result: Send,
{ /* private fields */ }

A thread pool to manage the distribution of jobs to worker threads.

Template Parameters

• Job - The job type that should be processed by the worker threads.
• Result - The result type that should be returned by the worker threads.

Both Job and Result must implement the Send trait.

Implementations

impl<Job: Send + JobTrait + 'static, Result: Send + ResultTrait + 'static> ThreadPool<Job, Result>

pub fn new<Argument: Send + 'static>( args: Vec<Argument>, func: fn(usize, Job, &Sender<Result>, &Sender<Job>, &mut Argument), ) -> ThreadPool<Job, Result>

Create a new thread pool with a given number of worker threads (args.len()). Each worker thread will receive an argument from the args vector. When a new job is published to the thread pool, the thread pool will distribute the job to the worker threads and execute the func function within a worker thread.

Arguments

• args - A vector of arguments that should be passed to the worker threads.
• func - The worker entry function to process jobs.

Returns

• ThreadPool - The thread pool struct with the worker threads.

Template Parameters

• Argument - The argument type that should be passed to the worker threads. The argument type must implement the Send trait.

pub fn publish(&self, job: Job)

Publish a new job to the thread pool. The job will be distributed to a worker thread.

Arguments

• job - The job that should be processed by a worker thread.

pub fn receive(&self) -> Result<Result, RecvError>

Receive a result from the worker threads. This function will block until a result is available.

Returns

• Result - The result of a job processed by a worker thread.

Errors

• If all worker threads panicked, therefore the pipe is closed

pub fn receive_timeout( &self, timeout: Duration, ) -> Result<Result, RecvTimeoutError>

Receive a result from the worker threads. This function will block until a result is available or a timeout occurs.

Arguments

• timeout - The maximum time to wait for a result.

Returns

• Result - The result of a job processed by a worker thread.

Errors

• If all worker threads panicked, therefore the pipe is closed
• If the timeout occurs before a result is available

Trait Implementations

impl<Job: Send, Result: Send> Drop for ThreadPool<Job, Result>

fn drop(&mut self)

Executes the destructor for this type.