Struct ThreadPool

pub struct ThreadPool { /* private fields */ }

A thread pool for running fork-join workloads.

Implementations

impl ThreadPool

pub fn new() -> Self

Crates a new thread pool with default Config.

Examples

let _tp = ThreadPool::new();

pub fn with_config(config: Config) -> Self

Creates a new thread pool with config.

Examples

let _tp = ThreadPool::with_config(Config {
    thread_count: Some(NonZero::new(1).unwrap()),
    heartbeat_interval: Duration::from_micros(50),
});

pub fn set_global(self) -> Result<(), Self>

Sets the global thread pool to this one.

The global thread pool can only be set once. Any subsequent call will return the thread pool back.

Examples

ThreadPool::with_config(Config {
    thread_count: Some(NonZero::new(1).unwrap()),
    heartbeat_interval: Duration::from_micros(50),
})
.set_global()
.unwrap();

pub fn global() -> &'static ThreadPool

Returns the global thread pool.

Examples

let mut s = ThreadPool::global().scope();

let mut vals = [0; 2];
let (left, right) = vals.split_at_mut(1);

s.join(|_| left[0] = 1, |_| right[0] = 1);

assert_eq!(vals, [1; 2]);

pub fn scope(&self) -> Scope<'_>

Returns a Scoped object that you can run fork-join workloads on.

Examples

let mut tp = ThreadPool::new();
let mut s = tp.scope();

let mut vals = [0; 2];
let (left, right) = vals.split_at_mut(1);

s.join(|_| left[0] = 1, |_| right[0] = 1);

assert_eq!(vals, [1; 2]);

Trait Implementations

impl Debug for ThreadPool

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

Formats the value using the given formatter.

impl Default for ThreadPool

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ThreadPool

fn drop(&mut self)

Executes the destructor for this type.