Struct tokio_executor::DefaultExecutor

[+] Show declaration

pub struct DefaultExecutor { /* fields omitted */ }

[−] Expand description

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

Methods

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.

Trait Implementations

impl Debug for DefaultExecutor

[+]

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

[−]

Formats the value using the given formatter.

impl Clone for DefaultExecutor

[+]

fn clone(&self) -> DefaultExecutor

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Executor for DefaultExecutor

[+]

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