Skip to main content

NanoMonotonicClock

Struct NanoMonotonicClock 

Source
pub struct NanoMonotonicClock { /* private fields */ }
Expand description

A clock implementation that provides nanosecond-precision monotonic time.

This clock combines the monotonic guarantees of MonotonicClock with the nanosecond precision of NanoClock. It uses std::time::Instant as its time source and stores the base time with nanosecond precision.

§Use Cases

  • High-precision performance testing
  • Microbenchmarking
  • Scenarios requiring nanosecond-level time measurements

§Thread Safety

This type is completely thread-safe as all fields are immutable after creation.

§Examples

use qubit_clock::{NanoClock, NanoMonotonicClock};

let clock = NanoMonotonicClock::new();
let start = clock.nanos();

// Perform some operation
for _ in 0..1000 {
    // Some work
}

let elapsed = clock.nanos() - start;
println!("Elapsed: {} ns", elapsed);

§Author

Haixing Hu

Implementations§

Source§

impl NanoMonotonicClock

Source

pub fn new() -> Self

Creates a new NanoMonotonicClock.

The clock records the current instant and system time (with nanosecond precision) as its base point. All subsequent time queries will be calculated relative to this base point.

§Returns

A new NanoMonotonicClock instance.

§Examples
use qubit_clock::NanoMonotonicClock;

let clock = NanoMonotonicClock::new();
Source

pub fn elapsed(&self) -> Duration

Returns the elapsed monotonic duration since this clock was created.

This value is based purely on Instant and is not affected by system time adjustments.

§Returns

The elapsed monotonic duration.

§Examples
use qubit_clock::NanoMonotonicClock;
use std::thread;
use std::time::Duration;

let clock = NanoMonotonicClock::new();
thread::sleep(Duration::from_millis(10));
assert!(clock.elapsed() >= Duration::from_millis(10));
Source

pub fn monotonic_nanos(&self) -> i128

Returns the elapsed monotonic time in nanoseconds since creation.

Unlike NanoClock::nanos, this value does not include a wall-clock epoch anchor and is intended for interval measurement.

§Returns

The elapsed monotonic nanoseconds, saturated at i128::MAX.

§Examples
use qubit_clock::NanoMonotonicClock;
use std::thread;
use std::time::Duration;

let clock = NanoMonotonicClock::new();
thread::sleep(Duration::from_millis(10));
assert!(clock.monotonic_nanos() >= 10_000_000);

Trait Implementations§

Source§

impl Clock for NanoMonotonicClock

Source§

fn millis(&self) -> i64

Returns the current time as a Unix timestamp in milliseconds (UTC). Read more
Source§

fn time(&self) -> DateTime<Utc>

Returns the current time as a DateTime<Utc>. Read more
Source§

impl Clone for NanoMonotonicClock

Source§

fn clone(&self) -> NanoMonotonicClock

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NanoMonotonicClock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NanoMonotonicClock

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl NanoClock for NanoMonotonicClock

Source§

fn nanos(&self) -> i128

Returns the current time as a Unix timestamp in nanoseconds (UTC). Read more
Source§

fn time_precise(&self) -> DateTime<Utc>

Returns the current time as a DateTime<Utc> with nanosecond precision. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.