Struct kyansel::Cancellable

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Cancellable<F, S> where
    F: Future,
    S: Future,  { /* fields omitted */ }

Future for the cancel_with combinator, allowing a computation to be cancelled if a second computation completes succesfully.

If the future is cancelled it will complete as a CancellableError::Cancelled

Created with FutureCancellable::cancel_with or cancellable

Trait Implementations

impl<F: Debug, S: Debug> Debug for Cancellable<F, S> where
    F: Future,
    S: Future, 

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

Formats the value using the given formatter.

impl<F, S> Future for Cancellable<F, S> where
    F: Future,
    S: Future, 

type Output = CancellableResult<F::Output, S::Output>

The type of value produced on completion.

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

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