Struct CancelSignal 

pub struct CancelSignal(/* private fields */);

A one-way, clonable cancellation signal with children, using std only. Raising a signal raises every child created from it; a child can be raised alone.

Implementations

impl CancelSignal

pub fn new() -> Self

pub fn raise(&self)

pub fn is_raised(&self) -> bool

pub fn child(&self) -> CancelSignal

A signal raised when this one is, or on its own.

pub fn poll_raised(&self, cx: &mut Context<'_>) -> Poll<()>

Ready once raised; registers the task’s waker otherwise.

pub fn registered(&self) -> usize

Wakers and live children registered on this signal, for diagnostics: a signal shared across many waiters must not accumulate them.

pub fn raised(&self) -> impl Future<Output = ()> + Send + '_

Resolves once raised.

Trait Implementations

impl Clone for CancelSignal

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 CancelSignal

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

Formats the value using the given formatter.

impl Default for CancelSignal

fn default() -> Self

Returns the “default value” for a type.