Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cancellation token that can be shared across tasks. When cancelled, it will cancel all linked child tasks/tokens. Thread-safe and can be cloned.

Implementations

impl CancelToken

pub fn new() -> CancelToken

Create a new cancellation token that is not cancelled and has no children.

pub fn is_cancelled(&self) -> bool

Check if this token has been cancelled. Thread-safe.

pub fn link<T>(&self, child: T)

where T: Cancellable + 'static,

Attach a child task/token to be cancelled when this token is cancelled. If already cancelled, child is cancelled immediately.

pub fn cancel(&self)

Cancel this token and all currently-linked children.

pub fn into_linked<T>(&self) -> T

where T: Cancellable + Default + Clone + 'static,

Create a new cancellable task/token of type T, link it to this token, and return it. See Self::link for more details.

pub fn linked<T>(&self, child: T) -> T

where T: Cancellable + Clone + 'static,

Link an existing cancellable task/token of type T to this token and return it. See Self::link for more details.

Trait Implementations

impl Cancellable for CancelToken

fn cancel(&self)

Cancel the task. Should be idempotent and thread-safe.

fn is_cancelled(&self) -> bool

Check if the task has been cancelled. Should be thread-safe.

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.