Struct TimeStamp

pub struct TimeStamp { /* private fields */ }

A fixed point in time relative to a reference point in time.

The reference point depends on how the time stamp is created:

• Clock return time stamp relative to the clock start.
• TimeStamp::now returns time stamp relative to the global reference point initialized by the first call to this function.
• Functions that create time stamp from another time stamp return time stamp relative to the reference point of the original time stamp.
• User decides what reference point is for time spans returned by other mechanisms.

Implementations

impl TimeStamp

pub const fn start() -> Self

Constructs the smallest possible time stamp.

pub const fn never() -> Self

Constructs the largest possible time stamp.

It is practically impossible to reach it without using artificially large time spans.

pub fn from_elapsed(nanos: u64) -> Option<Self>

Constructs time stamp from number of nanoseconds elapsed since reference point in time.

pub unsafe fn new_unchecked(nanos: u64) -> Self

Constructs time stamp from number of nanoseconds elapsed since reference point in time.

Safety

nanos must not be 0.

pub fn from_duration(duration: Duration) -> Option<Self>

Constructs time stamp from duration since reference point in time.

pub fn from_observed_duration(duration: Duration) -> Self

Constructs time stamp from duration observed by the process.

Given that duration is measured by the process, it is impossible to overflow as it would mean that process runs for more than 500 years.

Panics

Panics if overflow occurs.

pub const fn checked_elapsed_since(self, earlier: TimeStamp) -> Option<TimeSpan>

Returns time span elapsed since earlier point in time.

pub fn elapsed_since(self, earlier: TimeStamp) -> TimeSpan

Returns time span elapsed since earlier point in time.

Panics

Panics if earlier time stamp is greater than self time stamp.

pub fn elapsed_since_start(self) -> TimeSpan

Returns time span elapsed since start point in time.

pub fn nanos_since_start(self) -> u64

Returns time span elapsed since start point in time.

pub fn checked_add(self, span: TimeSpan) -> Option<TimeStamp>

Returns checked time stamp after adding given time span.

Trait Implementations

impl Add<TimeSpan> for TimeStamp

type Output = TimeStamp

The resulting type after applying the + operator.

fn add(self, rhs: TimeSpan) -> Self

Performs the + operation.

impl AddAssign<TimeSpan> for TimeStamp

fn add_assign(&mut self, rhs: TimeSpan)

Performs the += operation.

impl Clone for TimeStamp

fn clone(&self) -> TimeStamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeStamp

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

Formats the value using the given formatter.

impl Display for TimeStamp

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

Formats the value using the given formatter.

impl Hash for TimeStamp

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 TimeStamp

fn cmp(&self, other: &TimeStamp) -> 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 TimeStamp

fn eq(&self, other: &TimeStamp) -> 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 TimeStamp

fn partial_cmp(&self, other: &TimeStamp) -> 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 Sub for TimeStamp

type Output = TimeSpan

The resulting type after applying the - operator.

fn sub(self, rhs: TimeStamp) -> TimeSpan

Performs the - operation.

impl Copy for TimeStamp

impl Eq for TimeStamp

impl StructuralPartialEq for TimeStamp