Struct blocking_pool::Builder

pub struct Builder { /* fields omitted */ }

A builder for a thread pool.

Examples

use blocking_pool::ThreadPool;

let pool = ThreadPool::builder()
    .max_threads(128)
    .thread_name("my-app-worker-thread")
    .build();

Implementations

impl Builder

#[must_use]

pub fn new() -> Self

Construct a new builder with its default values.

#[must_use]

pub fn max_threads(self, max_threads: usize) -> Self

Set the maximum number of threads that can exist at a time in the thread pool. If all the threads are currently working and new work comes in, it will have to wait for a thread to be free in order to start.

The default value is 512, but this may change in the future.

#[must_use]

pub fn thread_name<N: Into<Cow<'static, str>>>(self, name: N) -> Self

Set the name that the spawned threads have.

The default value is blocking-worker, but this may change in the future.

#[must_use]

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

Set the stack size of each spawned worker thread.

If unset, currently it will use the RUST_MIN_STACK environment variable or default to 2 MiB if that is not present, but this behaviour may change in the future.

#[must_use]

pub fn idle_timeout(self, idle_timeout: Duration) -> Self

Set the duration a worker thread waits for without any work to perform before exiting.

The default value is 10 seconds, but this may change in the future.

#[must_use]

pub fn build(self) -> ThreadPool

Consume this builder and return the newly created thread pool.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.