Struct glommio::timer::Timer

pub struct Timer { /* fields omitted */ }

A timer that expires after a duration of time.

Timers are futures that output the Instant at which they fired. Note that because of that, Timers always block the current task queue in which they currently execute.

In most situations you will want to use TimerActionOnce

Examples

Sleep for 100 milliseconds:

use glommio::{timer::Timer, LocalExecutor};
use std::time::Duration;

async fn sleep(dur: Duration) {
    Timer::new(dur).await;
}

let ex = LocalExecutor::default();

ex.run(async {
    sleep(Duration::from_millis(100)).await;
});

Implementations

impl Timer

pub fn new(dur: Duration) -> Timer

Creates a timer that expires after the given duration of time.

Examples

use glommio::{timer::Timer, LocalExecutor};
use std::time::Duration;

let ex = LocalExecutor::default();
ex.run(async move {
    Timer::new(Duration::from_millis(100)).await;
});

pub fn reset(&mut self, dur: Duration)

Resets the timer to expire after the new duration of time.

Note that resetting a timer is different from creating a new timer because reset() does not remove the waker associated with the task that is polling the timer.

Examples

use glommio::{timer::Timer, LocalExecutor};
use std::time::Duration;

let ex = LocalExecutor::default();
ex.run(async move {
    let mut t = Timer::new(Duration::from_secs(1));
    t.reset(Duration::from_millis(100));
    t.await;
});

Trait Implementations

impl Debug for Timer

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

Formats the value using the given formatter.

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.

impl Future for Timer

type Output = Instant

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.