Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cancellation signal shared by a task store and the work it owns.

Cloned tokens share the same underlying signal: cancelling any clone cancels them all. The token is backed by tokio_util::sync::CancellationToken, so it can be checked synchronously or awaited. A store must raise the same signal for explicit cancellation and expiry; see TaskStore::create_task.

This task-lifecycle token is intentionally a separate type from crate::context::CancellationToken, which belongs to the originating request.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a new, un-cancelled token.

TaskStore::create_task has to return one of these, so the public constructor lets external task stores create the process-local signal they bridge to durable cancellation and expiry state.

pub fn is_cancelled(&self) -> bool

Check whether cancellation or expiry has been signalled.

pub fn cancel(&self)

Signal cancellation or expiry to every clone and waiter.

pub async fn cancelled(&self)

Wait until cancellation or expiry is signalled.

Completes immediately if the token was already signalled.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.