Struct WithCancellationTokenFuture 

pub struct WithCancellationTokenFuture<'a, F: Future> {
    run_until_cancelled: Option<RunUntilCancelledFuture<'a, F>>,
}

A Future that is resolved once the corresponding CancellationToken is cancelled or a given Future gets resolved.

This future is immediately resolved if the corresponding CancellationToken is already cancelled, otherwise, in case of concurrent completion and cancellation, this is biased towards the future completion.

Fields

run_until_cancelled: Option<RunUntilCancelledFuture<'a, F>>

Implementations

impl<'a, F: Future> WithCancellationTokenFuture<'a, F>

pub(crate) fn new(cancellation_token: &'a CancellationToken, future: F) -> Self

Trait Implementations

impl<'a, F: Future> Future for WithCancellationTokenFuture<'a, 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.

impl<'__pin, 'a, F: Future> Unpin for WithCancellationTokenFuture<'a, F>

where PinnedFieldsOf<__Origin<'__pin, 'a, F>>: Unpin,