Struct tokio::executor::DefaultExecutor

pub struct DefaultExecutor { /* private fields */ }

Executes futures on the default executor for the current execution context.

DefaultExecutor implements Executor and can be used to spawn futures without referencing a specific executor.

When an executor starts, it sets the DefaultExecutor handle to point to an executor (usually itself) that is used to spawn new tasks.

The current DefaultExecutor reference is tracked using a thread-local variable and is set using tokio_executor::with_default

Implementations

impl DefaultExecutor

pub fn current() -> DefaultExecutor

Returns a handle to the default executor for the current context.

Futures may be spawned onto the default executor using this handle.

The returned handle will reference whichever executor is configured as the default at the time spawn is called. This enables DefaultExecutor::current() to be called before an execution context is setup, then passed into an execution context before it is used.

This is also true for sending the handle across threads, so calling DefaultExecutor::current() on thread A and then sending the result to thread B will not reference the default executor that was set on thread A.

Trait Implementations

impl Clone for DefaultExecutor

pub fn clone(&self) -> DefaultExecutor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultExecutor

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

Formats the value using the given formatter.

impl Executor for DefaultExecutor

pub fn spawn(
    &mut self,
    future: Box<dyn Future<Item = (), Error = ()> + Send + 'static, Global>
) -> Result<(), SpawnError>

Spawns a future object to run on this executor.

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

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

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

pub 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 DefaultExecutor where
    T: Future<Item = (), Error = ()> + Send + 'static, 

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

Spawns a future to run on this executor.

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

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