Struct timer_kit::Timeout

pub struct Timeout<D, Fut> { /* private fields */ }

A timeout future.

It returns <Fut as Future>::Output if the future completes before the timeout or Elapsed if the timeout elapses before the future completes.

Warning - Exhaustion

This future is not able to avoid exhaustion if the future never completes and never returns Pending. The user should ensure that the Fut future is able to return Pending at some point to avoid exhaustion.

Implementations

impl<D, Fut> Timeout<D, Fut>where
    D: Delay,
    Fut: Future,

pub fn new(duration: Duration, future: Fut) -> Self

Creates a new Timeout with a specified duration.

Example

Creates a timeout with smol’s timer

use std::time::Duration;
use timer_kit::Timeout;
 
let result = Timeout::<smol::Timer, _>::new(Duration::from_millis(100), async {}).await;

Creates a timeout with fluvio_wasm_timer::Delay

use std::time::Duration;
use timer_kit::Timeout;
 
let result = Timeout::<fluvio_wasm_timer::Delay, _>::new(Duration::from_millis(100), async {}).await;

pub fn new_at(deadline: D::Instant, future: Fut) -> Self

Creates a new Timeout with a specified deadline.

Example

Creates a timeout with smol’s timer

use std::time::{Duration, Instant};
use timer_kit::Timeout;

let result = Timeout::<smol::Timer, _>::new_at(Instant::now() + Duration::from_millis(100), async {}).await;

Creates a timeout with fluvio_wasm_timer::Delay

use std::time::Duration;
use fluent_wasm_timer::Instant;
use timer_kit::Timeout;
 
let result = Timeout::<fluvio_wasm_timer::Delay, _>::new_at(Instant::now() + Duration::from_millis(100), async {}).await;

Trait Implementations

impl<D, Fut> Future for Timeout<D, Fut>where
    D: Delay,
    Fut: Future,

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

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &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, D, Fut> Unpin for Timeout<D, Fut>where
    __Origin<'__pin, D, Fut>: Unpin,