Struct PoolBuilder 

pub struct PoolBuilder { /* private fields */ }

Configuration of a Pool.

Examples

use strided_exec::Pool;

let pool = Pool::builder()
    .threads(2)
    .stack_size(8 << 20)
    .on_start(|_worker| { /* e.g. pin the thread */ })
    .build()?;
assert!(pool.width().get() >= 1);

Implementations

impl PoolBuilder

pub fn threads(self, n: usize) -> Self

Number of worker threads. Defaults to the available parallelism.

Zero is rejected by build; the pool never falls back to an environment-dependent default.

Examples

use strided_exec::{Error, Pool};

assert_eq!(Pool::builder().threads(0).build().unwrap_err(), Error::ZeroThreads);

pub fn thread_name(self, f: impl Fn(usize) -> String + 'static) -> Self

Names the workers; the closure receives the worker index.

Examples

let pool = strided_exec::Pool::builder()
    .threads(1)
    .thread_name(|i| format!("my-pool-{i}"))
    .build()?;

pub fn stack_size(self, bytes: usize) -> Self

Worker stack size in bytes. Defaults to 16 MiB, sized for recursive LU.

Examples

let pool = strided_exec::Pool::builder().threads(1).stack_size(4 << 20).build()?;

pub fn on_start(self, f: impl Fn(usize) + Send + Sync + 'static) -> Self

Hook run on each worker when it starts, with the worker index.

Typical use is pinning the worker to a core. The hook is not called without the parallel feature, which starts no workers.

Examples

let pool = strided_exec::Pool::builder().threads(1).on_start(|_| {}).build()?;

pub fn build(self) -> Result<Pool, Error>

Starts the workers.

Without the parallel feature no thread is started and the pool has width 1.

Errors

Error::ZeroThreads when threads(0) was requested, and Error::PoolBuild when the workers cannot be started.

Examples

let pool = strided_exec::Pool::builder().threads(2).build()?;
assert!(pool.width().get() <= 2);

Trait Implementations

impl Debug for PoolBuilder

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

Formats the value using the given formatter.