Struct CancellationScope 

pub struct CancellationScope { /* private fields */ }

Cooperative cancellation scope for an owned operation and its children.

The implementation wraps Tokio internally, while the public contract does not expose Tokio tokens, runtime handles, channels, or tasks. Cancellation is idempotent and propagates from parent scopes to children.

Implementations

impl CancellationScope

pub fn new() -> Self

Creates a pending root cancellation scope.

pub fn child(&self) -> Self

Creates a child cancelled when this parent is cancelled.

Cancelling the child does not cancel this parent.

pub fn cancel(&self)

Requests cooperative cancellation for this scope and its children.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

pub async fn cancelled(&self)

Waits until cancellation is requested.

Trait Implementations

impl Clone for CancellationScope

fn clone(&self) -> CancellationScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationScope

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

Formats the value using the given formatter.

impl Default for CancellationScope

fn default() -> Self

Returns the “default value” for a type.