Struct tokio_io_pool::Handle

pub struct Handle { /* fields omitted */ }

A handle to a Runtime that allows spawning additional futures from other threads.

Methods

impl Handle

pub fn spawn<F>(&self, future: F) -> Result<&Self, SpawnError> where
    F: Future<Output = ()> + Send + 'static, 

Spawn a future onto a runtime in the pool.

This spawns the given future onto a single thread runtime's executor. That thread is then responsible for polling the future until it completes.

pub fn spawn_all<S>(
    &self,
    stream: S
) -> impl Future<Output = Result<(), StreamSpawnError<<S as TryStream>::Error>>> where
    S: TryStream,
    <S as TryStream>::Ok: Future<Output = ()> + Send + 'static, 

Spawn all futures yielded by a stream onto the pool.

This produces a future that accepts futures from a Stream and spawns them all onto the pool round-robin.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Executor for Handle

fn spawn(
    &mut self,
    future: Pin<Box<dyn Future<Output = ()> + Send + 'static>>
) -> Result<(), SpawnError>

Spawns a future object to run on this executor.

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

Provides a best effort hint to whether or not spawn will succeed.