Trait Shield

pub trait Shield
where
    Self: Future + Send + 'static,
    Self::Output: Send,
{
    type ShieldFuture: Future<Output = Self::Output>;
    type TryShieldFuture: Future<Output = Result<Self::Output, Self::TryShieldError>>;
    type TryShieldError;

    // Required methods
    fn shield(self) -> Self::ShieldFuture;
    fn try_shield(self) -> Self::TryShieldFuture;
}

Adds methods to futures to prevent them from being aborted.

Required Associated Types

type ShieldFuture: Future<Output = Self::Output>

The Future returned from shield().

type TryShieldFuture: Future<Output = Result<Self::Output, Self::TryShieldError>>

The Future returned from try_shield().

type TryShieldError

The error returned from try_shield().

Required Methods

fn shield(self) -> Self::ShieldFuture

Prevent this future from being aborted by wrapping it in a task.

future.shield().await is equivalent to future.try_shield().await.unwrap().

Panics

This function panics if awaiting the spawned task fails.

fn try_shield(self) -> Self::TryShieldFuture

Prevent this future from being aborted by wrapping it in a task.

Since the task is created using tokio::spawn(), execution of this future starts immediately.

Implementors

impl<T> Shield for T

where T: Future + Send + 'static, T::Output: Send,

type ShieldFuture = Map<JoinHandle<<T as Future>::Output>, fn(Result<<T as Future>::Output, JoinError>) -> <T as Future>::Output>

type TryShieldFuture = JoinHandle<<T as Future>::Output>

type TryShieldError = JoinError