Struct CancelSignal 

pub struct CancelSignal { /* private fields */ }

An awaitable cancel signal triggered by a Canceler.

Implementations

impl CancelSignal

pub async fn guard<F>(&self, future: F) -> Result<F::Output, Canceled>

where F: Future,

Waits for the given future until the cancel signal is triggered.

If the signal is triggered, this function drops the future and returns a Canceled error.

pub fn is_triggered(&self) -> bool

Returns true if the cancel signal has been triggered.

pub async fn listen(&self)

Waits for the cancel signal to be triggered.

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 Default for CancelSignal

fn default() -> CancelSignal

Returns the “default value” for a type.