Struct monotonic_clock::MonotonicClock

pub struct MonotonicClock { /* private fields */ }

Monotonic Clock

A monotonic clock that can be anchored to a specific Epoch. The clock is guaranteed to be monotonic, but not necessarily continuous.

Thread safety

The clock is thread safe.

Eventually, we want to have network synchronization, but for now, we just use the system clock. TODO: Add network synchronization.

Example

use monotonic_clock::MonotonicClock;
use std::thread;
use std::time::Duration;
let clock = MonotonicClock::new();
let start = clock.now();
thread::sleep(Duration::from_millis(100));
let end = clock.now();
assert!(end - start >= Duration::from_millis(100));

Implementations

impl MonotonicClock

pub fn new() -> MonotonicClock

Create a new monotonic clock.

pub fn reset(&mut self)

Reset the clock to zero.

pub fn start(&mut self)

Start the clock.

pub fn resume(&mut self) -> Option<Duration>

Resumes paused clock. If the clock is not stopped, this does nothing.

pub fn stop(&mut self) -> Option<Duration>

Stop the clock if it’s running, otherwise does nothing. Returns the duration the clock was running.

pub fn now(&self) -> Duration

Get duration since the clock has been running time.

pub fn time(&self) -> Duration

Get the now time since the epoch.

pub fn time_as_float(&self) -> f64

Get the now time since the epoch as a float.

pub fn as_float(&self) -> f64

Get the now time since the epoch as a float. This is a convenience function for clock_as_float. It is provided for compatibility with the time crate.

pub fn is_ticking(&self) -> bool

Is the clock running?

Trait Implementations

impl Clone for MonotonicClock

fn clone(&self) -> MonotonicClock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MonotonicClock

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

Formats the value using the given formatter.

impl Default for MonotonicClock

fn default() -> Self

Returns the “default value” for a type.

impl Display for MonotonicClock

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

Formats the value using the given formatter.

impl Hash for MonotonicClock

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Into<Duration> for MonotonicClock

fn into(self) -> Duration

Get the now time since the clock’s epoch.

impl Ord for MonotonicClock

fn cmp(&self, other: &MonotonicClock) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<MonotonicClock> for MonotonicClock

fn eq(&self, other: &MonotonicClock) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<MonotonicClock> for MonotonicClock

fn partial_cmp(&self, other: &MonotonicClock) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MonotonicClock

impl Eq for MonotonicClock

impl StructuralEq for MonotonicClock

impl StructuralPartialEq for MonotonicClock