Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A shareable token for requesting cooperative transfer cancellation.

Clones refer to the same cancellation state. Calling Self::cancel on any clone makes Self::is_cancelled return true on every clone. Cancellation cannot be reset. An in-progress blocking read is not interrupted immediately; cancellation is checked at defined points in the transfer implementation.

Implementations

impl CancellationToken

pub fn new() -> Self

Creates a token in the non-cancelled state.

pub fn cancel(&self)

Requests cancellation for every operation sharing this token.

This method returns immediately and does not wait for a read or transfer to stop.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> Self

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.