Struct Pool 

pub struct Pool(/* private fields */);

A Pool object represents a private thread pool with its own thread limits.

This is in contrast to the default, or shared, thread pool used by the crate’s submit function as well as other code within the same process.

Implementations

impl Pool

pub fn new() -> Self

Creates a new Pool object.

pub fn with_scope<'env, F>(f: F)

where F: for<'scope> FnOnce(&'scope Scope<'scope, 'env>),

Convenience function for creating a new pool and calling scope.

pub fn set_thread_limits(&self, min: u32, max: u32)

Sets the thread limits for the Pool object.

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

Submit the closure to the thread pool.

• The closure must have 'static lifetime as the thread may outlive the lifetime in which submit is called.
• The closure must be Send as it will be sent to another thread for execution.

pub fn scope<'env, F>(&self, f: F)

where F: for<'scope> FnOnce(&'scope Scope<'scope, 'env>),

Create a scope for submitting closures.

Within this scope local variables can be sent to the pool thread for execution. This is possible because scope will wait for all submitted closures to finish before returning, Note however that it will also wait for closures that were submitted from other threads.

pub fn join(&self)

Waits for all submissions to finish.

Dropping the Pool will also wait for all submissions to finish.

Trait Implementations

impl Default for Pool

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Pool

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Pool

impl Sync for Pool