Struct Monotonic 

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

Available on crate feature std only.

A captured monotonic instant.

Monotonic wraps a single sample of the operating system’s monotonic clock. Two readings can be compared to recover the Duration between them with duration_since or the safer checked_duration_since.

Monotonic and Wall are deliberately distinct types with no cross-type arithmetic. The compiler will reject any attempt to mix them — that separation is the central design choice of this crate.

Construct one with Monotonic::now or the crate-level now shortcut.

Examples

use clock_lib::Monotonic;

let start = Monotonic::now();
// ... do some work ...
let took = start.elapsed();
assert!(took.as_nanos() < u128::MAX);

Implementations

impl Monotonic

pub fn now() -> Self

Captures the current monotonic time from the operating system.

This is the constructor for Monotonic. The crate-level now function is a one-line shortcut for the same thing.

Examples

use clock_lib::Monotonic;

let t = Monotonic::now();

pub fn elapsed(self) -> Duration

Returns the Duration elapsed since this reading was captured.

Equivalent to Monotonic::now().duration_since(self).

Examples

use clock_lib::Monotonic;

let t = Monotonic::now();
let _ = t.elapsed();

pub fn duration_since(self, earlier: Self) -> Duration

Returns the Duration between two readings.

Panics

Panics if earlier is later than self. Prefer checked_duration_since or saturating_duration_since when the ordering is not guaranteed by construction.

Examples

use clock_lib::Monotonic;

let earlier = Monotonic::now();
let later = Monotonic::now();
let _delta = later.duration_since(earlier);

pub fn checked_duration_since(self, earlier: Self) -> Option<Duration>

Returns Some(duration) if self >= earlier, otherwise None.

The non-panicking counterpart to duration_since.

Examples

use clock_lib::Monotonic;

let earlier = Monotonic::now();
let later = Monotonic::now();
assert!(later.checked_duration_since(earlier).is_some());

pub fn saturating_duration_since(self, earlier: Self) -> Duration

Returns the duration since earlier, saturating at zero when earlier is later than self.

Examples

use clock_lib::Monotonic;

let a = Monotonic::now();
let b = Monotonic::now();
// Regardless of which is later, this never panics.
let _ = a.saturating_duration_since(b);

Trait Implementations

impl Clone for Monotonic

fn clone(&self) -> Monotonic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Monotonic

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

Formats the value using the given formatter.

impl Hash for Monotonic

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Monotonic

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Monotonic

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Monotonic

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Monotonic

impl Eq for Monotonic

impl StructuralPartialEq for Monotonic