tokio_util::sync::cancellation_token

Struct RunUntilCancelledFuture

Source 
pub(crate) struct RunUntilCancelledFuture<'a, F: Future> {
    cancellation: WaitForCancellationFuture<'a>,
    future: F,
}
Expand description

A Future that is resolved once the corresponding CancellationToken is cancelled or a given Future gets resolved. It is biased towards the Future completion.

Fields§

§cancellation: WaitForCancellationFuture<'a>§future: F

Implementations§

Source§

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

Source

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

Trait Implementations§

Source§

impl<'a, F: Future> Future for RunUntilCancelledFuture<'a, F>

Source§

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

The type of value produced on completion.
Source§

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. Read more
Source§

impl<'__pin, 'a, F: Future> Unpin for RunUntilCancelledFuture<'a, F>
where PinnedFieldsOf<__Origin<'__pin, 'a, F>>: Unpin,

Auto Trait Implementations§

§

impl<'a, F> !Freeze for RunUntilCancelledFuture<'a, F>

§

impl<'a, F> !RefUnwindSafe for RunUntilCancelledFuture<'a, F>

§

impl<'a, F> Send for RunUntilCancelledFuture<'a, F>
where F: Send,

§

impl<'a, F> Sync for RunUntilCancelledFuture<'a, F>
where F: Sync,

§

impl<'a, F> !UnwindSafe for RunUntilCancelledFuture<'a, F>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T
where T: Future + ?Sized,

Source§

fn with_cancellation_token( self, cancellation_token: &CancellationToken, ) -> WithCancellationTokenFuture<'_, Self> ⓘ
where Self: Sized,

Similar to CancellationToken::run_until_cancelled, but with the advantage that it is easier to write fluent call chains, and biased towards waiting for CancellationToken to complete. Read more
Source§

fn with_cancellation_token_owned( self, cancellation_token: CancellationToken, ) -> WithCancellationTokenFutureOwned<Self> ⓘ
where Self: Sized,

Similar to CancellationToken::run_until_cancelled_owned, but with the advantage that it is easier to write fluent call chains, and biased towards waiting for CancellationToken to complete. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.