Struct ShutdownController 

pub struct ShutdownController { /* private fields */ }

Permits to keep track of ongoing tasks, ask them to shutdown and wait for all of them to quit. Stupid wrapper around tokio_util::sync::CancellationToken and tokio_util::task::task_tracker::TaskTracker.

Implementations

impl ShutdownController

pub fn new() -> Self

pub fn ask_shutdown(&self)

Ask for all tasks to quit

pub async fn wait_all_task_shutdown(self)

Wait for all tasks to quit. This task may return even without having called ShutdownController::ask_shutdown first, if all tasks quit by themselves.

pub fn token(&self) -> ShutdownToken

Returns a new shutdown token, to be held by a task.

pub fn delegate(&self) -> ShutdownDelegate

Returns a ShutdownDelegate, which is able to ask for shutdown, without counting as a task that needs to be awaited.

pub fn wait(&self) -> WaitForCancellationFuture<'_>

Returns a future that will resolve only when a shutdown request happened.

Trait Implementations

impl Clone for ShutdownController

fn clone(&self) -> ShutdownController

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ShutdownController

fn default() -> ShutdownController

Returns the “default value” for a type.