[−][src]Struct futures::executor::ThreadPoolBuilder
Thread pool configuration object.
Methods
impl ThreadPoolBuilder
[src]
impl ThreadPoolBuilder
pub fn new() -> ThreadPoolBuilder
[src]
pub fn new() -> ThreadPoolBuilder
Create a default thread pool configuration.
See the other methods on this type for details on the defaults.
pub fn pool_size(&mut self, size: usize) -> &mut ThreadPoolBuilder
[src]
pub fn pool_size(&mut self, size: usize) -> &mut ThreadPoolBuilder
Set size of a future ThreadPool
The size of a thread pool is the number of worker threads spawned. By default, this is equal to the number of CPU cores.
pub fn stack_size(&mut self, stack_size: usize) -> &mut ThreadPoolBuilder
[src]
pub fn stack_size(&mut self, stack_size: usize) -> &mut ThreadPoolBuilder
Set stack size of threads in the pool.
By default, worker threads use Rust's standard stack size.
pub fn name_prefix<S>(&mut self, name_prefix: S) -> &mut ThreadPoolBuilder where
S: Into<String>,
[src]
pub fn name_prefix<S>(&mut self, name_prefix: S) -> &mut ThreadPoolBuilder where
S: Into<String>,
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.
By default, worker threads are assigned Rust's standard thread name.
pub fn after_start<F>(&mut self, f: F) -> &mut ThreadPoolBuilder where
F: Fn(usize) + Send + Sync + 'static,
[src]
pub fn after_start<F>(&mut self, f: F) -> &mut ThreadPoolBuilder where
F: Fn(usize) + Send + Sync + 'static,
Execute the closure f
immediately after each worker thread is started,
but before running any tasks on it.
This hook is intended for bookkeeping and monitoring.
The closure f
will be dropped after the builder
is dropped
and all worker threads in the pool have executed it.
The closure provided will receive an index corresponding to the worker thread it's running on.
pub fn before_stop<F>(&mut self, f: F) -> &mut ThreadPoolBuilder where
F: Fn(usize) + Send + Sync + 'static,
[src]
pub fn before_stop<F>(&mut self, f: F) -> &mut ThreadPoolBuilder where
F: Fn(usize) + Send + Sync + 'static,
Execute closure f
just prior to shutting down each worker thread.
This hook is intended for bookkeeping and monitoring.
The closure f
will be dropped after the builder
is droppped
and all threads in the pool have executed it.
The closure provided will receive an index corresponding to the worker thread it's running on.
pub fn create(&mut self) -> Result<ThreadPool, Error>
[src]
pub fn create(&mut self) -> Result<ThreadPool, Error>
Trait Implementations
impl Default for ThreadPoolBuilder
[src]
impl Default for ThreadPoolBuilder
fn default() -> ThreadPoolBuilder
[src]
fn default() -> ThreadPoolBuilder
Returns the "default value" for a type. Read more
impl Debug for ThreadPoolBuilder
[src]
impl Debug for ThreadPoolBuilder
Auto Trait Implementations
impl Send for ThreadPoolBuilder
impl Send for ThreadPoolBuilder
impl Sync for ThreadPoolBuilder
impl Sync for ThreadPoolBuilder
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,