Struct cancel_safe_futures::coop_cancel::Canceler

pub struct Canceler<T> { /* private fields */ }

Available on crate feature std only.

A cooperative cancellation sender.

For more information, see the module documentation.

Implementations

impl<T> Canceler<T>

pub fn cancel(&self, message: T) -> Result<Waiter<T>, T>

Performs a cancellation with a message.

This sends the message immediately, and returns a Waiter that can be optionally waited against to block until the corresponding Receiver is dropped.

Only the first message ever sent via any Canceler is received by the Receiver.

Returns Err(message) if the corresponding Receiver has already been dropped, which means that the cancel operation failed.

Trait Implementations

impl<T> Clone for Canceler<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Canceler<T>

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

Formats the value using the given formatter.