Struct Timeout 

pub struct Timeout<F: Future> { /* private fields */ }

Wraps a future and cancels it if it does not complete within duration.

Created by timeout(). Returns Ok(value) if the future wins the race, or Err(Elapsed) if the timer fires first.

Implementation

Both the inner future and the deadline share the same Waker. Whichever completes first causes poll to be called again, where the winner is detected and returned.

ctx.spawn(async move {
    match timeout(Duration::from_secs(5), fetch_data()).await {
        Ok(data) => display(data),
        Err(Elapsed) => show_error("Request timed out"),
    }
});

Trait Implementations

impl<F: Future> Future for Timeout<F>

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

The type of value produced on completion.

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.