Struct Timeout 

pub struct Timeout<'bemly_, Content> { /* private fields */ }

Available on crate feature nano-alloc only.

A wrapper that adds a time limit to a Future.

If the internal future does not complete before the deadline (in hardware ticks), it returns Err(()). Otherwise, it returns Ok(Output).

Examples

use uefi_async::nano_alloc::time::Timeout;

 async fn calc_1() {}
 async fn calc_2() {
    match Box::pin(calc_2()).timeout(Duration::from_secs(2).as_secs()).await { _ => () }
    match Timeout::new_pin(Box::pin(calc_2()), 500).await { _ => () }
    match Timeout::new(calc_1(), 300).await { _ => () }
    match calc_2().timeout(500).await { Ok(_) => {}, Err(_) => {} }
 }

Implementations

impl<'bemly_, Content> Timeout<'bemly_, Content>

pub fn new(future: impl Future<Output = Content> + 'bemly_, ticks: u64) -> Self

Creates a new Timeout by pinning the provided future to the heap.

ticks is the relative duration from the current time.

pub fn new_pin( future: Pin<Box<dyn Future<Output = Content> + 'bemly_>>, ticks: u64, ) -> Self

Creates a new Timeout from an already pinned future.

Useful when the future is already boxed or has a complex lifetime.

Trait Implementations

impl<'bemly_, Content> Future for Timeout<'bemly_, Content>

type Output = Result<Content, ()>

Returns Ok(T) if finished in time, or Err(()) if the deadline is exceeded.

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.