Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cloneable handle over a shared cancellation flag.

Clones share the same underlying flag: cancelling any clone is observed by all of them. This is what lets the stream layer hold one handle while the executor holds another and still agree on whether to stop.

Implementations

impl CancelToken

pub fn new() -> Self

A fresh, un-cancelled token.

pub fn cancel(&self)

Raise the cancel signal. Idempotent — cancelling an already-cancelled token is a no-op. Visible to every clone of this token.

pub fn is_cancelled(&self) -> bool

true once any clone of this token has been cancelled.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelToken

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

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> Self

Returns the “default value” for a type.