Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cancellation flag. Clones share one flag; a child has its own, and is cancelled when it or any ancestor is.

A function reads the run’s token through Ctx::cancel, and hands a child to a run it starts, so cancelling the parent cancels both.

use dataflow_rs::run::CancelToken;

let parent = CancelToken::new();
let child = parent.child();
child.cancel();
assert!(child.is_cancelled() && !parent.is_cancelled());
let other = parent.child();
parent.cancel();
assert!(other.is_cancelled());

Implementations

impl CancelToken

pub fn new() -> Self

A token not yet cancelled, with no parent.

pub fn cancel(&self)

Cancels this token, its clones and every child made from them. Every task awaiting cancelled on them is woken.

pub fn is_cancelled(&self) -> bool

Whether this token or any of its ancestors was cancelled.

pub fn child(&self) -> Self

A token cancelled with this one, or on its own without cancelling this one.

pub async fn cancelled(&self)

Resolves once this token or any of its ancestors is cancelled, at once if one already is: for a host’s own races, such as a tokio::select! between its I/O and the run’s token. Native targets only.

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

Whether it is cancelled.

impl Default for CancelToken

fn default() -> Self

Returns the “default value” for a type.