Builder

Struct Builder 

Source
pub struct Builder { /* private fields */ }
Expand description

Thread pool configuration object

Builder starts with a number of workers equal to the number of CPUs on the host. But you can change it until you call create().

Implementations§

Source§

impl Builder

Source

pub fn new() -> Builder

Create a builder a number of workers equal to the number of CPUs on the host.

Source

pub fn pool_size(&mut self, size: usize) -> &mut Self

Set size of a future ThreadPool

The size of a thread pool is the number of worker threads spawned

Source

pub fn name_prefix<S: Into<String>>(&mut self, name_prefix: S) -> &mut Self

Set thread name prefix of a future ThreadPool

Thread name prefix is used for generating thread names. For example, if prefix is my-pool-, then threads in the pool will get names like my-pool-1 etc.

Source

pub fn after_start<F>(&mut self, f: F) -> &mut Self
where F: Fn() + Send + Sync + 'static,

Execute function f right after each thread is started but before running any jobs on it

This is initially intended for bookkeeping and monitoring uses

Source

pub fn before_stop<F>(&mut self, f: F) -> &mut Self
where F: Fn() + Send + Sync + 'static,

Execute function f before each worker thread stops

This is initially intended for bookkeeping and monitoring uses

Source

pub fn create(&mut self) -> ThreadPool

Create ThreadPool with configured parameters

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SpawnHelper for T

Source§

fn spawn<F>( &self, future: F, ) -> SpawnHandle<<F as Future>::Item, <F as Future>::Error>
where F: Future, Self: Spawn<Spawned<F>>,

Spawns a future to run on this Spawn, returning a future representing the produced value. Read more
Source§

fn spawn_fn<F, R>( &self, f: F, ) -> SpawnHandle<<R as IntoFuture>::Item, <R as IntoFuture>::Error>
where F: FnOnce() -> R, R: IntoFuture, Self: Spawn<Spawned<Lazy<F, R>>>,

Spawns a closure on this Spawn Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.