Struct WrapCancel

Source
pub struct WrapCancel<T: Clone, F> { /* private fields */ }
Expand description

Wrapped future that is automatically cancelled when a shutdown is triggered.

If the wrapped future completes before the shutdown is triggered, the output of the original future is yielded as Ok(value).

If the shutdown is triggered before the wrapped future completes, the original future is dropped and the shutdown reason is yielded as Err(shutdown_reason).

Trait Implementations§

Source§

impl<T: Clone, F: Future> Future for WrapCancel<T, F>

Source§

type Output = Result<<F as Future>::Output, T>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, context: &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

Auto Trait Implementations§

§

impl<T, F> Freeze for WrapCancel<T, F>
where F: Freeze, T: Freeze,

§

impl<T, F> RefUnwindSafe for WrapCancel<T, F>

§

impl<T, F> Send for WrapCancel<T, F>
where F: Send, T: Send,

§

impl<T, F> Sync for WrapCancel<T, F>
where F: Sync, T: Sync + Send,

§

impl<T, F> Unpin for WrapCancel<T, F>
where F: Unpin, T: Unpin,

§

impl<T, F> UnwindSafe for WrapCancel<T, F>
where F: UnwindSafe, T: UnwindSafe,

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, 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.