Struct Canceler 

pub struct Canceler { /* private fields */ }

A task canceler that triggers a cloneable CancelSignal.

Implementations

impl Canceler

pub fn new() -> Self

Creates a new task canceler.

pub fn inherit(cancel: CancelSignal) -> Self

Creates a new task canceler that inherits the state of an existing cancel signal.

When the given cancel signal is triggered, the canceler will trigger its own cancel signal.

pub fn cancel(&self)

Triggers all cancel signals.

pub fn is_triggered(&self) -> bool

Returns true if the cancel signals have been triggered.

pub fn signal(&self) -> CancelSignal

Returns a CancelSignal that is triggered by this canceler.

Trait Implementations

impl Default for Canceler

fn default() -> Self

Returns the “default value” for a type.