Struct Cancellable 

pub struct Cancellable<F> { /* private fields */ }

A future that resolves to Some(output) when inner completes, or to None as soon as the token is cancelled, dropping inner first.

Async launchers for cancellable functions wrap the producer’s future in one of these. The waker is registered on the token before the flag is checked, so a cancellation racing a poll is never missed.

Implementations

impl<F: Future> Cancellable<F>

pub fn new(fut: F, token: CancelToken) -> Self

Race fut against token. A handle on a null token never cancels.

Trait Implementations

impl<F: Debug> Debug for Cancellable<F>

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

Formats the value using the given formatter.

impl<F> Drop for Cancellable<F>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<F: Future> Future for Cancellable<F>

type Output = Option<<F as Future>::Output>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.