Struct smol_timeout::Timeout

pub struct Timeout<Fut: Future> { /* fields omitted */ }

A future polling both another future and a [Timer] that will complete after a specified timeout, and returning the future's output or None if the timer completes first.

Example

use smol_timeout::TimeoutExt;
use std::time::Duration;

let foo = async {
    Timer::after(Duration::from_millis(250)).await;
    24
};

let foo = foo.timeout(Duration::from_millis(100));
assert_eq!(foo.await, None);

let bar = async {
    Timer::after(Duration::from_millis(100)).await;
    42
};

let bar = bar.timeout(Duration::from_millis(250));
assert_eq!(bar.await, Some(42));

Trait Implementations

impl<Fut: Debug + Future> Debug for Timeout<Fut>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Fut: Future> Future for Timeout<Fut>

type Output = Option<Fut::Output>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'__pin, Fut: Future> Unpin for Timeout<Fut> where
    __Origin<'__pin, Fut>: Unpin,