Struct LocalPool 

pub struct LocalPool { /* private fields */ }

A single-threaded task pool for polling futures to completion.

This executor allows you to multiplex any number of tasks onto a single thread. It’s appropriate to poll strictly I/O-bound futures that do very little work in between I/O actions.

To get a handle to the pool that implements Spawn, use the spawner() method. Because the executor is single-threaded, it supports a special form of task spawning for non-Send futures, via spawn_local_obj.

Implementations

impl LocalPool

pub fn new() -> Self

Create a new, empty pool of tasks.

pub fn spawner(&self) -> LocalSpawner

Get a clonable handle to the pool as a Spawn.

pub fn run<P: Park>(&mut self, park: &mut P, enter: &mut Enter)

Run all tasks in the pool to completion.

The function will block the calling thread until all tasks in the pool completed, including any spawned while running existing tasks.

pub fn run_until<P: Park, F: Future>( &mut self, park: &mut P, enter: &mut Enter, future: F, ) -> F::Output

Runs all the tasks in the pool until the given future completes.

The given spawner, spawn, is used as the default spawner for any newly-spawned tasks. You can route these additional tasks back into the LocalPool by using its spawner handle:

The function will block the calling thread only until the future f completes; there may still be incomplete tasks in the pool, which will be inert after the call completes, but can continue with further use of one of the pool’s run or poll methods. While the function is running, however, all tasks in the pool will try to make progress.

pub fn poll_pool(&mut self, cx: &mut Context<'_>) -> Poll<()>

Make progress on entire pool, polling each spawend task at most once.

Becomes Ready when all tasks are completed.

pub fn spawn(&self, future: LocalFutureObj<'static, ()>)

Spawn future on pool

Trait Implementations

impl Debug for LocalPool

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

Formats the value using the given formatter.

impl Default for LocalPool

fn default() -> Self

Returns the “default value” for a type.

impl LocalSpawn for LocalPool

fn spawn_local_obj( &mut self, future: LocalFutureObj<'static, ()>, ) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

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

Determines whether the executor is able to spawn new tasks.

impl Spawn for LocalPool

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.