Crate async_timeouts

Source
Expand description

§Async Timeouts Helper

It is a simple instrument to delay execution of an async task with additional methods:

  • reset timeout with a new value, i.e. to delay execution of your task;
  • restart timeout with a new or previous task;
  • stop the timer before your task will be executed;
  • finished — check if the timer of the task is over or not.

It is convinient to use this crate with Notify or different channels (i.e. async_channel).

§Example

use std::time::{Duration, Instant};
use async_timeouts::Timeout;
use tokio::sync::Notify;
use std::sync::Arc;
 
#[tokio::main]
async fn main() {
    let event = Arc::new(Notify::new());
    let timer = Instant::now();
    {
        let event = event.clone();
        // Let's notify our event after 3 seconds
        Timeout::set(Duration::from_secs(3), async move {
            event.notify_one();
        }).await;
    }
    event.notified().await;
    println!("{} seconds elapsed", timer.elapsed().as_secs());
}

Structs§

Timeout
See more information about reset and stop methods