Struct BasicPool 

pub struct BasicPool { /* private fields */ }

Native standard thread pool with persistent workers.

This is the default thread pool when the std feature is enabled without transient-pool, persistent-pool-rayon, or wasm features. Note that the thread pool to be used for a parallel computation can be set by the runner transformation separately for each parallel iterator.

Value of max_num_threads is determined as the minimum of:

• the available parallelism of the host obtained via std::thread::available_parallelism(), and
• the upper bound set by the environment variable “ORX_NUM_THREADS”, when set.

Implementations

impl BasicPool

pub fn new(num_threads: impl Into<NumThreads>) -> Self

Creates a BasicPool with persistent worker threads.

The effective thread count is the minimum of the requested num_threads, the ORX_NUM_THREADS environment limit when set, and the available system parallelism.

Trait Implementations

impl Clone for BasicPool

fn clone(&self) -> BasicPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for BasicPool

fn default() -> Self

Returns the “default value” for a type.

impl ThreadPool for BasicPool

type ScopeRef<'s, 'env, 'scope> = &'s ScopeRef<'env> where 'scope: 's, 'env: 'scope + 's

Scope type of the thread pool.

fn max_num_threads(&self) -> NonZeroUsize

Returns the maximum number of threads available in the pool.

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

where for<'s> F: FnOnce(&'s ScopeRef<'env>) + Send, 'env: 'scope,

Executes the scoped computation f.

fn run_all(&self, tasks: impl TaskQueue + Send)

Runs all tasks in parallel on this pool.

impl ThreadPool for &BasicPool

type ScopeRef<'s, 'env, 'scope> = &'s ScopeRef<'env> where 'scope: 's, 'env: 'scope + 's

Scope type of the thread pool.

fn max_num_threads(&self) -> NonZeroUsize

Returns the maximum number of threads available in the pool.

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

where for<'s> F: FnOnce(&'s ScopeRef<'env>) + Send, 'env: 'scope,

Executes the scoped computation f.

fn run_all(&self, tasks: impl TaskQueue + Send)

Runs all tasks in parallel on this pool.

impl ThreadPool for &mut BasicPool

type ScopeRef<'s, 'env, 'scope> = &'s ScopeRef<'env> where 'scope: 's, 'env: 'scope + 's

Scope type of the thread pool.

fn max_num_threads(&self) -> NonZeroUsize

Returns the maximum number of threads available in the pool.

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

where for<'s> F: FnOnce(&'s ScopeRef<'env>) + Send, 'env: 'scope,

Executes the scoped computation f.

fn run_all(&self, tasks: impl TaskQueue + Send)

Runs all tasks in parallel on this pool.