Struct AutoDropTimer

pub struct AutoDropTimer(/* private fields */);

Implementations

impl AutoDropTimer

pub fn from_timer(t: Timer) -> Self

Takes over the underlying timer and returns an instance of AutoDropTimer, encapsulating the Timer.

After calling this function, the timer t is moved into the AutoDropTimer.

Parameters

• t: The timer instance to be encapsulated.

Returns

Returns the AutoDropTimer instance.

pub fn new<F>( clk: Clock, duration: Duration, f: F, name: String, ) -> AnyResult<Self>

where F: FnOnce() + Send + Sync + 'static,

Creates an instance of AutoDropTimer on the clock indicated by the clk parameter.

Arguments

• clk: The clock instance on which to create the timer.
• duration: Specifies the expiration duration of the timer.
• f: Callback function invoked after the timer expires.
• name: Name of the timer, used for logging purposes.

Returns

Returns Ok(AutoDropTimer) if successful, or an error if creation fails.

pub fn cancel(&mut self) -> AnyResult<()>

Cancels the timer before it expires.

Returns Ok(()) if it is successfully canceled, or an error if the timer has already expired. Applications should handle the race condition where a timer may expire after cancel is invoked.

Returns

Returns Ok(()) if the timer is successfully canceled, or an error otherwise.

pub fn take(&mut self) -> Option<Timer>

Extracts the Timer from the AutoDropTimer.

Applications need to handle canceling the timer when the Timer instance is dropped after calling this function.

Returns

Returns the Timer if it exists, or None if it has been canceled.

pub fn expired(&mut self)

Informs the AutoDropTimer to perform cleanup when the timer expires.

This function is primarily for performance considerations; functionally, it does not affect whether calling it or not on expiry.