Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

A wrapped CancellationToken that is used for signalling and listening for cancellation requests.

Implementations

impl ShutdownToken

pub fn send_status_msg(&self, status: Box<dyn TaskStatusEvent>)

👎Deprecated

A drop in no-op replacement for send_status_msg for easier migration from TaskClient.

pub fn new() -> ShutdownToken

Creates a new ShutdownToken in the non-cancelled state.

pub fn new_from_tokio_token( cancellation_token: CancellationToken, ) -> ShutdownToken

Creates a new ShutdownToken given a tokio CancellationToken.

pub fn inner(&self) -> &CancellationToken

Gets reference to the underlying CancellationToken.

pub fn to_cancellation_token(&self) -> CancellationToken

Get an owned CancellationToken for public API use. This is useful when you need to expose cancellation to SDK users without exposing the internal ShutdownToken type.

pub fn child_token(&self) -> ShutdownToken

Creates a ShutdownToken which will get cancelled whenever the current token gets cancelled. Unlike a cloned ShutdownToken, cancelling a child token does not cancel the parent token.

If the current token is already cancelled, the child token will get returned in cancelled state.

pub fn cancel(&self)

Cancel the underlying CancellationToken and all child tokens which had been derived from it.

This will wake up all tasks which are waiting for cancellation.

pub fn is_cancelled(&self) -> bool

Returns true if the underlying CancellationToken is cancelled.

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

Returns a Future that gets fulfilled when cancellation is requested.

The future will complete immediately if the token is already cancelled when this method is called.

Cancel safety

This method is cancel safe.

pub fn cancelled_owned(self) -> WaitForCancellationFutureOwned

Returns a Future that gets fulfilled when cancellation is requested.

The future will complete immediately if the token is already cancelled when this method is called.

The function takes self by value and returns a future that owns the token.

Cancel safety

This method is cancel safe.

pub fn drop_guard(self) -> ShutdownDropGuard

Creates a ShutdownDropGuard for this token.

Returned guard will cancel this token (and all its children) on drop unless disarmed.

pub async fn run_until_cancelled<F>( &self, fut: F, ) -> Option<<F as Future>::Output>

where F: Future,

Runs a future to completion and returns its result wrapped inside an Option unless the ShutdownToken is cancelled. In that case the function returns None and the future gets dropped.

Cancel safety

This method is only cancel safe if fut is cancel safe.

pub async fn run_until_cancelled_owned<F>( self, fut: F, ) -> Option<<F as Future>::Output>

where F: Future,

Runs a future to completion and returns its result wrapped inside an Option unless the ShutdownToken is cancelled. In that case the function returns None and the future gets dropped.

The function takes self by value and returns a future that owns the token.

Cancel safety

This method is only cancel safe if fut is cancel safe.

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.

impl Debug for ShutdownToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ShutdownToken

fn default() -> ShutdownToken

Returns the “default value” for a type.

impl From<CancellationToken> for ShutdownToken

fn from(inner: CancellationToken) -> ShutdownToken

Converts to this type from the input type.