Struct async_executors::ThreadPool

pub struct ThreadPool { /* private fields */ }

A general-purpose thread pool for scheduling tasks that poll futures to completion.

The thread pool multiplexes any number of tasks onto a fixed number of worker threads.

This type is a clonable handle to the threadpool itself. Cloning it will only create a new reference, not a new threadpool.

This type is only available when the thread-pool feature of this library is activated.

Implementations

impl ThreadPool

pub fn new() -> Result<ThreadPool, Error>

Creates a new thread pool with the default configuration.

See documentation for the methods in ThreadPoolBuilder for details on the default configuration.

pub fn builder() -> ThreadPoolBuilder

Create a default thread pool configuration, which can then be customized.

See documentation for the methods in ThreadPoolBuilder for details on the default configuration.

pub fn spawn_obj_ok(&self, future: FutureObj<'static, ()>)

Spawns a future that will be run to completion.

Note: This method is similar to Spawn::spawn_obj, except that it is guaranteed to always succeed.

pub fn spawn_ok<Fut>(&self, future: Fut) where
    Fut: 'static + Future<Output = ()> + Send, 

Spawns a task that polls the given future with output () to completion.

use futures::executor::ThreadPool;

let pool = ThreadPool::new().unwrap();

let future = async { /* ... */ };
pool.spawn_ok(future);

Note: This method is similar to SpawnExt::spawn, except that it is guaranteed to always succeed.

Trait Implementations

impl Clone for ThreadPool

fn clone(&self) -> ThreadPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadPool

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

Formats the value using the given formatter.

impl Drop for ThreadPool

fn drop(&mut self)

Executes the destructor for this type.

impl Spawn for ThreadPool

fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

impl<Out: 'static + Send> SpawnHandle<Out> for ThreadPool

fn spawn_handle_obj(
    &self,
    future: FutureObj<'static, Out>
) -> Result<JoinHandle<Out>, SpawnError>

Spawn a future and return a JoinHandle that can be awaited for the output of the future.

impl Timer for ThreadPool

Available on crate features timer and async_global only.

fn sleep(&self, dur: Duration) -> BoxFuture<'static, ()>

Future that resolves after a given duration.

impl YieldNow for ThreadPool

fn yield_now(&self) -> YieldNowFut

Await this future in order to yield to the executor.