Struct yastl::Pool

pub struct Pool { /* fields omitted */ }

A structure providing access to a pool of worker threads and a way to spawn jobs.

It spawns n threads at creation and then can be used to spawn scoped threads via Pool::scoped() or unscoped threads via Pool::spawn().

Implementations

impl Pool

pub fn new(n: usize) -> Self

Create a new Pool that will execute it’s tasks on n worker threads.

Panics

If n is zero.

pub fn with_config(n: usize, config: ThreadConfig) -> Self

Create a new Pool that will execute it’s tasks on n worker threads and spawn them using the given config.

Panics

If n is zero.

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

Spawn an unscoped job onto this thread pool.

This method doesn’t wait until the job finishes.

pub fn scoped<'scope, F, R>(&self, job: F) -> R where
    F: FnOnce(&Scope<'scope>) -> R, 

Spawn scoped jobs which guarantee to be finished before this method returns and thus allows to borrow local varaiables.

pub fn shutdown(&self)

Send a shutdown signal to every worker thread and wait for their termination.

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.