Struct Timeout

pub struct Timeout { /* private fields */ }

See more information about reset and stop methods

Implementations

impl Timeout

pub async fn set( timeout: Duration, f: impl Future<Output = ()> + Send + 'static, ) -> Self

Schedule the task inside closure after timeout

pub async fn reset(&self, timeout: Duration)

Reset timeout with a new value, i.e. to delay execution of your task

Example

use std::time::Duration;
use async_timeouts::Timeout;
use tokio::sync::Notify;
use std::sync::Arc;
 
#[tokio::main]
async fn main() {
    let event = Arc::new(Notify::new());
    let event_cloned = event.clone();
    let x = Timeout::set(Duration::from_secs(3), async move {
        println!("This message will be printed after 6 seconds");
        event_cloned.notify_one();
    }).await;
    x.reset(Duration::from_secs(6)).await;
    event.notified().await;
}

pub async fn stop(&self)

Stop timer before your task will be executed

Example

use std::time::Duration;
use async_timeouts::Timeout;
use tokio::sync::Notify;
use std::sync::Arc;
 
#[tokio::main]
async fn main() {
    let event = Arc::new(Notify::new());
     
    let event_cloned = event.clone();
    let x = Timeout::set(Duration::from_secs(3), async move {
        println!("This message will never be printed and event will never be notified.");
        event_cloned.notify_one();
    }).await;
     
    x.stop().await;
    event.notified().await;
}

Trait Implementations

impl Clone for Timeout

fn clone(&self) -> Timeout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Timeout

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

Formats the value using the given formatter.