Struct tokio_util::sync::cancellation_token::WaitForCancellationFutureOwned

pub struct WaitForCancellationFutureOwned {
    future: MaybeDangling<Notified<'static>>,
    cancellation_token: CancellationToken,
}

A Future that is resolved once the corresponding CancellationToken is cancelled.

This is the counterpart to WaitForCancellationFuture that takes CancellationToken by value instead of using a reference.

Fields

future: MaybeDangling<Notified<'static>>

cancellation_token: CancellationToken

Implementations

impl WaitForCancellationFutureOwned

fn new(cancellation_token: CancellationToken) -> Self

unsafe fn new_future( cancellation_token: &CancellationToken, ) -> Notified<'static>

Safety

The returned future must be destroyed before the cancellation token is destroyed.

Trait Implementations

impl Debug for WaitForCancellationFutureOwned

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

Formats the value using the given formatter.

impl Future for WaitForCancellationFutureOwned

type Output = ()

The type of value produced on completion.

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

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

impl<'__pin> Unpin for WaitForCancellationFutureOwned

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