ThreadPool

Struct ThreadPool 

Source
pub struct ThreadPool { /* private fields */ }
Expand description

Thread pool struct.

§Panics

Panics when the generic parameter (POOL_SIZE) is zero.

§Example

use std::thread;
use std::time;

use swimming_pool::ThreadPool;

fn main() {
    // Initialize a thread pool with 5 threads
    let pool = ThreadPool::new(5);

    pool.execute(|| {
        // Send job to the pool
        thread::sleep(time::Duration::from_secs(5));
    });

    pool.join_all();
}

Implementations§

Source§

impl ThreadPool

Source

pub fn new(size: usize) -> Self

Initialize a new thread pool

§Panics

Panics when the generic parameter (POOL_SIZE) is zero.

Source

pub fn execute<F: FnOnce() + Send + 'static>(&self, f: F)

Send a job to the pool. This job will be picked and executed by any free woker thread.

§Example
use threadpool::Threadpool;

let pool = ThreadPool::new(10);
pool.execute(|| {
    // Send job to the pool
});
Source

pub fn join_all(self)

Join all the worker threads (wait for them to finish executing their job).

Source

pub fn get_pool_size(&self) -> usize

Returns the number of worker threads in the thread pool.

Source

pub fn get_working_threads(&self) -> usize

Returns the number of woker threads which are currently executing a job.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.