Struct AtomicTimer

pub struct AtomicTimer { /* private fields */ }

Atomic timer

Implementations

impl AtomicTimer

pub fn new(duration: Duration) -> Self

Create a new atomic timer

Panics

Panics if the duration is too large (in nanos greater than i64::MAX)

pub fn duration(&self) -> Duration

Get the duration of the timer

Panics

Panics if the duration is negative

pub fn permit_handle_expiration(&self) -> bool

Similar to reset if expired but does not reset the timer. As the timer is checked for expiration, a tiny datarace may occur despite it passes the tests well. As soon as the timer is reset with any method, the flag is reset as well. If used in multi-threaded environment, “true” is returned to a single worker only. After, the flag is reset.

pub fn set_duration(&self, duration: Duration)

Change the duration of the timer

Panics

Panics if the duration in nanos is larger than i64::MAX

pub fn reset(&self)

Reset the timer

pub fn expire_now(&self)

Focibly expire the timer

pub fn reset_if_expired(&self) -> bool

Reset the timer if it has expired, returns true if reset. If used in multi-threaded environment, “true” is returned to a single worker only.

pub fn elapsed(&self) -> Duration

Get the elapsed time

In case if negative elapsed, returns Duration::ZERO

pub fn remaining(&self) -> Duration

Get the remaining time

In case if negative remaining, returns Duration::ZERO

pub fn expired(&self) -> bool

Check if the timer has expired