Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

Created by a ShutdownController. Serves two purposes:

• Wait for a shutdown request to happen with Self::wait
• Keep track of the current task. While this token is held, ShutdownController::wait_all_task_shutdown will block.

Implementations

impl ShutdownToken

pub fn split(self) -> (CancellationToken, TaskTrackerToken)

Returns underlying CancellationToken and TaskTrackerToken, consuming self.

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

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

pub fn is_shutdown(&self) -> bool

Returns true if the shutdown request happened

pub fn ask_shutdown(&self)

Ask for all tasks to quit

Trait Implementations

impl Clone for ShutdownToken

fn clone(&self) -> ShutdownToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.