Struct futures_executor::ThreadPool

pub struct ThreadPool { /* fields omitted */ }

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.

Methods

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 run<F: Future>(&mut self, f: F) -> F::Output

Runs the given future with this thread pool as the default spawner for spawning tasks.

This function will block the calling thread until the given future is complete. While executing that future, any tasks spawned onto the default spawner will be routed to this thread pool.

Note that the function will return when the provided future completes, even if some of the tasks it spawned are still running.

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: Future<Output = ()> + Send + 'static, 

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 Drop for ThreadPool

fn drop(&mut self)

Executes the destructor for this type.

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

Formats the value using the given formatter.

impl Spawn for ThreadPool

fn spawn_obj(
    &mut 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<'_> Spawn for &'_ ThreadPool

fn spawn_obj(
    &mut 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.