Function timeout

pub async fn timeout<F, T, E>(
    duration: Duration,
    future: F,
) -> Result<T, TimeoutError<E>>
where
    F: Future<Output = Result<T, E>>,

Available on crate feature async only.

Applies a maximum duration to a Result-returning future.

Whether the maximum duration was reached is indicated via the error type. Specifically:

• If future does not complete within duration, returns TimeoutError::DeadlineElapsed.
• If future completes with Ok(t), returns Ok(t).
• If future completes with Err(e), returns TimeoutError::Inner(e).

Using this function can be considerably more readable than tokio::time::timeout when the inner future returns a Result.

Examples

use mz_ore::future::TimeoutError;
let slow_op = async {
    tokio::time::sleep(Duration::from_secs(1)).await;
    Ok::<_, String>(())
};
let res = mz_ore::future::timeout(Duration::from_millis(1), slow_op).await;
assert_eq!(res, Err(TimeoutError::DeadlineElapsed));