Struct tokio::runtime::current_thread::Handle

pub struct Handle(_);

Handle to spawn a future on the corresponding CurrentThread runtime instance

Implementations

impl Handle

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

Spawn a future onto the CurrentThread runtime instance corresponding to this handle

Panics

This function panics if the spawn fails. Failure occurs if the CurrentThread instance of the Handle does not exist anymore.

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

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

This function may return both false positives and false negatives. If status returns Ok, then a call to spawn will probably succeed, but may fail. If status returns Err, a call to spawn will probably fail, but may succeed.

This allows a caller to avoid creating the task if the call to spawn has a high likelihood of failing.

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, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Executor<T> for Handle where
    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<T> TypedExecutor<T> for Handle where
    T: Future<Item = (), Error = ()> + Send + 'static, 

fn spawn(&mut self, future: T) -> 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.