Struct tokio::runtime::TaskExecutor

pub struct TaskExecutor { /* private fields */ }

Executes futures on the runtime

All futures spawned using this executor will be submitted to the associated Runtime’s executor. This executor is usually a thread pool.

For more details, see the module level documentation.

Implementations

impl TaskExecutor

pub fn spawn<F>(&self, future: F)where
    F: Future<Item = (), Error = ()> + Send + 'static,

Spawn a future onto the Tokio runtime.

This spawns the given future onto the runtime’s executor, usually a thread pool. The thread pool is then responsible for polling the future until it completes.

See module level documentation for more details.

Examples

use tokio::runtime::Runtime;

// Create the runtime
let mut rt = Runtime::new().unwrap();
let executor = rt.executor();

// Spawn a future onto the runtime
executor.spawn(future::lazy(|| {
    println!("now running on a worker thread");
    Ok(())
}));

Panics

This function panics if the spawn fails. Failure occurs if the executor is currently at capacity and is unable to spawn a new future.

Trait Implementations

impl Clone for TaskExecutor

fn clone(&self) -> TaskExecutor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskExecutor

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

Formats the value using the given formatter.

impl<T> Executor<T> for TaskExecutorwhere
    T: Future<Item = (), Error = ()> + Send + 'static,

fn execute(&self, future: T) -> Result<(), ExecuteError<T>>

Spawns a future to run on this Executor, typically in the “background”.

impl Executor for TaskExecutor

fn spawn(
    &mut self,
    future: Box<dyn Future<Item = (), Error = ()> + Send>
) -> 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.