Struct governor::clock::QuantaUpkeepClock

pub struct QuantaUpkeepClock { /* private fields */ }

A clock using the default quanta::Clock structure and an upkeep thread.

This clock relies on an upkeep thread that wakes up in regular (user defined) intervals to retrieve the current time and update an atomic U64; the clock then can retrieve that time (and is as behind as, at most, that interval).

The background thread is stopped as soon as the last clone of the clock is dropped.

Whether this is faster than a QuantaClock depends on the utilization of the rate limiter and the upkeep interval that you pick; you should measure and compare performance before picking one or the other.

Implementations

impl QuantaUpkeepClock

pub fn from_interval(interval: Duration) -> Result<QuantaUpkeepClock, Error>

Returns a new QuantaUpkeepClock with an upkeep thread that wakes up once in interval.

pub fn from_builder(builder: Upkeep) -> Result<QuantaUpkeepClock, Error>

Returns a new QuantaUpkeepClock with an upkeep thread as specified by the given builder.

Trait Implementations

impl Clock for QuantaUpkeepClock

type Instant = QuantaInstant

A measurement of a monotonically increasing clock.

fn now(&self) -> Self::Instant

Returns a measurement of the clock.

impl Clone for QuantaUpkeepClock

fn clone(&self) -> QuantaUpkeepClock

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuantaUpkeepClock

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

Formats the value using the given formatter.