Struct tokio_compat::runtime::current_thread::TaskExecutor

pub struct TaskExecutor { /* fields omitted */ }

This is supported on (feature="rt-current-thread" or feature="rt-full") and feature="rt-current-thread" only.

Executes futures on the current thread.

All futures executed using this executor will be executed on the current thread. As such, run will wait for these futures to complete before returning, if they are spawned without a JoinHandle.

For more details, see the module level documentation.

Methods

impl TaskExecutor

pub fn current() -> TaskExecutor

This is supported on feature="rt-current-thread" or feature="rt-full" only.

Returns an executor that executes futures on the current thread.

The user of TaskExecutor must ensure that when a future is submitted, that it is done within the context of a call to run.

For more details, see the module level documentation.

pub fn spawn_local(
    &mut self,
    future: impl Future01<Item = (), Error = ()> + 'static
) -> Result<(), SpawnError>

This is supported on feature="rt-current-thread" or feature="rt-full" only.

Spawn a futures 0.1 future onto the current CurrentThread instance.

pub fn spawn_local_std(
    &mut self,
    future: impl Future<Output = ()> + 'static
) -> Result<(), SpawnError>

This is supported on feature="rt-current-thread" or feature="rt-full" only.

Spawn a std::futures future onto the current CurrentThread instance.

pub fn spawn_handle<T: 'static, E: 'static>(
    &mut self,
    future: impl Future01<Item = T, Error = E> + 'static
) -> JoinHandle<Result<T, E>>

This is supported on feature="rt-current-thread" or feature="rt-full" only.

Spawn a futures 0.1 future onto the current CurrentThread instance, returning a JoinHandle that can be used to await its result.

Note that futures spawned in this manner do not "count" towards keeping the runtime active for shutdown_on_idle, since they are paired with a JoinHandle for awaiting their completion. See here for details on shutting down the compatibility runtime.

Panics

This function panics if there is no current runtime, or if the current runtime is not a current-thread runtime.

pub fn spawn_handle_std<T: 'static>(
    &mut self,
    future: impl Future<Output = T> + 'static
) -> JoinHandle<T>

This is supported on feature="rt-current-thread" or feature="rt-full" only.

Spawn a std::future future onto the current CurrentThread instance, returning a JoinHandle that can be used to await its result.

Note that futures spawned in this manner do not "count" towards keeping the runtime active for shutdown_on_idle, since they are paired with a JoinHandle for awaiting their completion. See here for details on shutting down the compatibility runtime.

Panics

This function panics if there is no current runtime, or if the current runtime is not a current-thread runtime.

Trait Implementations

impl Debug for TaskExecutor

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

Formats the value using the given formatter.

impl<T> Executor<T> for TaskExecutor where
    T: Future01<Item = (), Error = ()> + '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 Future01<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.

impl<F> TypedExecutor<F> for TaskExecutor where
    F: Future01<Item = (), Error = ()> + 'static, 

fn spawn(&mut self, future: F) -> Result<(), SpawnError>

Spawns a future to run on this executor.

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

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