Struct ChildToken 

pub struct ChildToken { /* private fields */ }

Child cancellation token that inherits from a parent.

Child tokens check both their local cancellation state and their parent’s state. This allows for hierarchical cancellation where a task can be cancelled independently or inherit cancellation from its parent workflow.

Cancellation Logic

A child token is cancelled if:

• The parent token is cancelled, OR
• The child’s local cancel() method was called

Example

let source = CancellationTokenSource::new();
let child = source.child_token();

// Child inherits parent cancellation
source.cancel();
assert!(child.is_cancelled());

// Or child can be cancelled independently
let source2 = CancellationTokenSource::new();
let child2 = source2.child_token();
child2.cancel();
assert!(child2.is_cancelled());
assert!(!source2.token().is_cancelled());

Implementations

impl ChildToken

pub fn is_cancelled(&self) -> bool

Returns true if either parent or local token is cancelled.

Checks both the parent token and local cancellation state.

Example

let source = CancellationTokenSource::new();
let child = source.child_token();

assert!(!child.is_cancelled());

// Cancel parent
source.cancel();
assert!(child.is_cancelled());

pub fn cancel(&self)

Cancels this child token locally.

Local cancellation does not affect the parent token or other children.

Example

let source = CancellationTokenSource::new();
let child1 = source.child_token();
let child2 = source.child_token();

child1.cancel();
assert!(child1.is_cancelled());
assert!(!child2.is_cancelled()); // Other children unaffected
assert!(!source.token().is_cancelled()); // Parent unaffected

Trait Implementations

impl Clone for ChildToken

fn clone(&self) -> ChildToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChildToken

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

Formats the value using the given formatter.