Struct TokioExecutorService 

pub struct TokioExecutorService { /* private fields */ }

Tokio-backed service for submitted blocking tasks.

The service accepts fallible Runnable and Callable tasks and runs them through Tokio’s blocking task pool.

Implementations

impl TokioExecutorService

pub fn new() -> TokioExecutorService

Creates a new service instance.

Returns

A Tokio-backed executor service.

impl TokioExecutorService

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

Waits asynchronously until the service has terminated.

Returns

A future that resolves after shutdown or stop has been requested and all accepted blocking tasks have finished or been aborted before start.

Trait Implementations

impl Clone for TokioExecutorService

fn clone(&self) -> TokioExecutorService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TokioExecutorService

fn default() -> TokioExecutorService

Returns the “default value” for a type.

impl ExecutorService for TokioExecutorService

fn submit<T, E>(&self, task: T) -> Result<(), SubmissionError>

where T: Runnable<E> + Send + 'static, E: Send + 'static,

Accepts a runnable and runs it through Tokio.

Parameters

• task - Runnable to execute on Tokio’s blocking task pool.

Returns

Ok(()) if the task was accepted.

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.

fn submit_callable<C, R, E>( &self, task: C, ) -> Result<<TokioExecutorService as ExecutorService>::ResultHandle<R, E>, SubmissionError>

where C: Callable<R, E> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts a callable and runs it through Tokio.

Parameters

• task - Callable to execute on Tokio’s blocking task pool.

Returns

A TaskHandle 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.

fn submit_tracked_callable<C, R, E>( &self, task: C, ) -> Result<<TokioExecutorService as ExecutorService>::TrackedHandle<R, E>, SubmissionError>

where C: Callable<R, E> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts a callable and returns an actively tracked handle.

Parameters

• task - Callable to execute on Tokio’s blocking task pool.

Returns

A TokioBlockingTaskHandle 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.

fn shutdown(&self)

Stops accepting new tasks.

Already accepted tasks are allowed to finish unless they are cancelled before their blocking closure starts.

fn stop(&self) -> StopReport

Stops accepting new tasks and requests abort for tracked Tokio tasks.

Tokio cannot abort blocking tasks that have already started. Such tasks continue running and keep the service active until their closure returns.

Returns

A report with queued and running blocking task counts observed when stop was requested, plus the number of queued blocking tasks that were actually cancelled before their blocking closures started.

fn lifecycle(&self) -> ExecutorServiceLifecycle

Returns the current lifecycle state.

fn is_not_running(&self) -> bool

Returns whether shutdown has been requested.

fn is_terminated(&self) -> bool

Returns whether shutdown was requested and all tasks are finished.

fn wait_termination(&self)

Blocks until the service has terminated.

type ResultHandle<R: Send + 'static, E: Send + 'static> = TaskHandle<R, E>

Result handle returned for an accepted callable task.

type TrackedHandle<R: Send + 'static, E: Send + 'static> = TokioBlockingTaskHandle<R, E>

Tracked handle returned for accepted tasks that expose status.

fn submit_tracked<T, E>( &self, task: T, ) -> Result<Self::TrackedHandle<(), E>, SubmissionError>

where T: Runnable<E> + Send + 'static, E: Send + 'static,

Submits a runnable task and returns a tracked handle.

fn is_running(&self) -> bool

Returns whether the service accepts new tasks.

fn is_shutting_down(&self) -> bool

Returns whether graceful shutdown is in progress.

fn is_stopping(&self) -> bool

Returns whether abrupt stop is in progress.