Trait WithTimeout

pub trait WithTimeout {
    type Output;

    // Required methods
    async fn with_timeout(
        self,
        timeout: Duration,
    ) -> Result<Self::Output, TimeoutError>;
    async fn with_deadline(
        self,
        at: Instant,
    ) -> Result<Self::Output, TimeoutError>;
}

Provides functions to run a given future with a timeout or a deadline.

Required Associated Types

type Output

Output type of the future.

Required Methods

async fn with_timeout( self, timeout: Duration, ) -> Result<Self::Output, TimeoutError>

Runs a given future with a timeout.

If the future completes before the timeout, its output is returned. Otherwise, on timeout, work on the future is stopped (poll is no longer called), the future is dropped and Err(TimeoutError) is returned.

async fn with_deadline(self, at: Instant) -> Result<Self::Output, TimeoutError>

Runs a given future with a deadline time.

If the future completes before the deadline, its output is returned. Otherwise, on timeout, work on the future is stopped (poll is no longer called), the future is dropped and Err(TimeoutError) is returned.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<F: Future> WithTimeout for F

type Output = <F as Future>::Output