Struct TokioIoExecutorService 

pub struct TokioIoExecutorService { /* private fields */ }

Tokio-backed executor service for async IO and Future-based tasks.

Accepted futures are spawned with tokio::spawn, so waiting for external IO does not occupy a dedicated blocking thread.

Implementations

impl TokioIoExecutorService

pub fn new() -> Self

Creates a new service instance.

Returns

A Tokio-backed executor service for Future-based tasks.

pub fn spawn<F, R, E>( &self, future: F, ) -> Result<TokioTaskHandle<R, E>, RejectedExecution>

where F: Future<Output = Result<R, E>> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts an async task and spawns it on the current Tokio runtime.

Parameters

• future - Future to execute on Tokio’s async scheduler.

Returns

A TokioTaskHandle for the accepted task.

Errors

Returns RejectedExecution::Shutdown if shutdown has already been requested before the task is accepted.

pub fn shutdown(&self)

Stops accepting new async tasks.

Already accepted tasks are allowed to finish unless aborted through their handles or by Self::shutdown_now.

pub fn shutdown_now(&self) -> ShutdownReport

Stops accepting new tasks and aborts tracked async tasks.

Returns

A report with zero queued tasks, the observed active-task count, and the number of Tokio abort handles signalled.

pub fn is_shutdown(&self) -> bool

Returns whether shutdown has been requested.

Returns

true if this service no longer accepts new async tasks.

pub fn is_terminated(&self) -> bool

Returns whether shutdown was requested and all async tasks are finished.

Returns

true only after shutdown has been requested and no accepted async tasks remain active.

pub fn await_termination(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>

Waits until the service has terminated.

Returns

A future that resolves after shutdown has been requested and all accepted async tasks have finished or been aborted.

Trait Implementations

impl Clone for TokioIoExecutorService

fn clone(&self) -> TokioIoExecutorService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TokioIoExecutorService

fn default() -> TokioIoExecutorService

Returns the “default value” for a type.