Struct OncePool 

pub struct OncePool { /* private fields */ }

A one-time-use thread pool.

This is not an actual thread pool, rather a configuration on number of threads to be spawned. Desired threads will be spawned just before the computation starts and will be released right after. Therefore, it may be considered as a one-time-use thread pool.

OncePool is used when the transient-pool feature is enabled. In this configuration, “orx-parallel” does not create and hold on to a persistent thread pool.

Implementations

impl OncePool

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

Assumes (*) a thread pool of num_threads threads.

Note that, this desired number of threads can be overwritten by the following:

• if the system has n < num_threads available threads, computation will use n threads.
• if ORX_NUM_THREADS environment variable exists with value m < num_threads, computation will use m threads.

(*) This is not an actual thread pool, rather a configuration on number of threads to be spawned. Desired threads will be spawned just before the computation starts and will be released right after. Therefore, it may be considered as a one-time-use thread pool.

Trait Implementations

impl Clone for OncePool

fn clone(&self) -> OncePool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OncePool

impl Debug for OncePool

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

Formats the value using the given formatter.

impl Default for OncePool

fn default() -> Self

Returns the “default value” for a type.

impl Sync for OncePool

impl ThreadPool for OncePool

type ScopeRef<'s, 'env, 'scope> = &'s Scope<'s, '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 Scope<'s, '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 &OncePool

type ScopeRef<'s, 'env, 'scope> = &'s Scope<'s, '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 Scope<'s, '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 OncePool

type ScopeRef<'s, 'env, 'scope> = &'s Scope<'s, '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 Scope<'s, '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.