Struct FlushTimer 

pub struct FlushTimer {
    deadline: Option<Instant>,
    sleep: Option<Pin<Box<Sleep>>>,
}

Maintains one reusable timer for the current flush deadline.

Creating a timer does not require a Tokio runtime. Arming it requires a Tokio runtime with time enabled. Disabling retains the allocation for the next arm.

Fields

deadline: Option<Instant>

sleep: Option<Pin<Box<Sleep>>>

Implementations

impl FlushTimer

pub fn new() -> Self

Creates a disabled timer without allocating a Tokio sleep.

pub fn set_deadline(&mut self, deadline: Option<Instant>)

Arms or disables the timer, resetting its sleep only when the deadline changes.

Panics

Arming for the first time panics outside a Tokio runtime with time enabled.

pub async fn wait(&mut self)

Waits until the armed deadline, or indefinitely while disabled.

Cancelling this wait does not change the deadline. An elapsed timer stays ready until the caller changes or disables its deadline.

Trait Implementations

impl Default for FlushTimer

fn default() -> FlushTimer

Returns the “default value” for a type.