Struct Alarm 

pub struct Alarm { /* private fields */ }

An alarm that can be Armed to fire at some future time.

Alarm is itself owned, and may have multiple sleepers attached to it. Each sleeper is awoken at most once for each alarm that has been set.

When instances of Alarm are dropped, sleepers are awoken, returning false, indicating that the alarm is defunct.

Implementations

impl Alarm

pub fn new() -> Self

Create a new, unset alarm.

pub fn arm(&mut self, duration: Duration)

Arm the alarm to fire after the provided duration.

pub fn rearm(&mut self, duration: Duration)

Arm the alarm to fire duration after the alarm was originally armed. This behaves as if arm was called originally with the new duration. If it has not been armed it behaves the same as arm.

pub fn disarm(&mut self)

Disarm the alarm, canceling any pending alarms.

pub fn fire(&mut self)

Fire the alarm immediately.

pub fn sleeper(&self) -> AlarmSleeper

Create a new sleeper for this alarm. Many sleepers can wait for the alarm to fire at any given time.

Trait Implementations

impl Default for Alarm

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Alarm

fn drop(&mut self)

Executes the destructor for this type.