Struct gloo_timers::future::TimeoutFuture

pub struct TimeoutFuture { /* private fields */ }

A scheduled timeout as a Future.

See TimeoutFuture::new for scheduling new timeouts.

Once scheduled, if you change your mind and don’t want the timeout to fire, you can drop the future.

A timeout future will never resolve to Err. Its only failure mode is when the timeout is so long that it is effectively infinite and never fires.

Example

use gloo_timers::future::TimeoutFuture;
use futures_util::future::{select, Either};
use wasm_bindgen_futures::spawn_local;

spawn_local(async {
    match select(TimeoutFuture::new(1_000), TimeoutFuture::new(2_000)).await {
        Either::Left((val, b)) => {
            // Drop the `2_000` ms timeout to cancel its timeout.
            drop(b);
        }
        Either::Right((a, val)) => {
            panic!("the `1_000` ms timeout should have won this race");
        }
    }
});

Implementations

impl TimeoutFuture

pub fn new(millis: u32) -> TimeoutFuture

Create a new timeout future.

Remember that futures do nothing unless polled or spawned, so either pass this future to wasm_bindgen_futures::spawn_local or use it inside another future.

Example

use gloo_timers::future::TimeoutFuture;
use wasm_bindgen_futures::spawn_local;

spawn_local(async {
    TimeoutFuture::new(1_000).await;
    // Do stuff after one second...
});

Trait Implementations

impl Debug for TimeoutFuture

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

Formats the value using the given formatter.

impl Future for TimeoutFuture

type Output = ()

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.