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.

TokioIoExecutorService intentionally has no service-level await_termination method. Await the task handles returned by Self::spawn when the caller needs to observe async task completion.

use qubit_tokio_executor::TokioIoExecutorService;

let service = TokioIoExecutorService::new();
service.await_termination().await;

Implementations

impl TokioIoExecutorService

pub fn new() -> TokioIoExecutorService

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>, SubmissionError>

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 SubmissionError::Shutdown if shutdown has already been requested before the task is accepted. Returns SubmissionError::WorkerSpawnFailed if the current thread is not entered into a Tokio runtime.

pub fn shutdown(&self)

Stops accepting new async tasks.

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

pub fn stop(&self) -> StopReport

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 lifecycle(&self) -> ExecutorServiceLifecycle

Returns the current lifecycle state.

Returns

ExecutorServiceLifecycle::Terminated after shutdown or stop and once no accepted async task remains active.

pub fn is_running(&self) -> bool

Returns whether this service still accepts async tasks.

Returns

true only while the lifecycle is ExecutorServiceLifecycle::Running.

pub fn is_shutting_down(&self) -> bool

Returns whether graceful shutdown is in progress.

Returns

true only while the lifecycle is ExecutorServiceLifecycle::ShuttingDown.

pub fn is_stopping(&self) -> bool

Returns whether abrupt stop is in progress.

Returns

true only while the lifecycle is ExecutorServiceLifecycle::Stopping.

pub fn is_not_running(&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.

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.