Struct Timeout

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

Available on WASI only.

A future that resolves to None after a certain amount of time, if the provided future has not resolved yet.

Example

let future = async {
   // do some work
};

let result = timeout(Duration::from_secs(1), future).await;
if let Some(result) = result {
   // do something with the result
} else {
  // the future timed out
}

Trait Implementations

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

type Output = Option<<F as Future>::Output>

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.