Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A cancellation token for signaling shutdown.

This is a simple atomic boolean that can be shared across actors. Supports hierarchical cancellation: a child token is considered cancelled when its parent is cancelled.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a new cancellation token.

pub fn child_token(&self) -> Self

Create a child token that is cancelled when this token is cancelled.

Cancelling the child does NOT cancel the parent.

pub fn cancel(&self)

Signal cancellation.

pub fn is_cancelled(&self) -> bool

Check if cancellation was requested (on this token or its parent).

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 Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.