Struct Instant32 

pub struct Instant32<const TICKS_PER_SEC: u32> { /* private fields */ }

An Instant type using a single unsigned integer tick counter

For this type, it might be easy to create these instants and to handle the underlying clock value, especially if the corresponding atomic type is available, see the documentation to TimespecInstant.

The main drawback might be that all additions and subtractions require divisions which might be inefficient on some platforms (when using an integer type larger than the word width of the processor):

1. Subtracting two instants yields a Duration which is a struct of seconds and (subsecond) nanoseconds. So this requires division and modulo to convert the simple tick difference into a Duration.
2. Adding/subtracting a Duration to/from an instant requires to convert the seconds and nanoseconds into the corresponding ticks. Converting the seconds only requires multiplication with TICKS_PER_SEC, but converting the nanoseconds requires division by nanos_per_sec (which is calculated internally). This division is only a 32 bit division though.

This instant type is generic on the clock frequency TICKS_PER_SEC. For example, in order to implement a millisecond clock, set TICKS_PER_SEC to 1000.

Implementations

impl<const TICKS_PER_SEC: u32> Instant32<TICKS_PER_SEC>

pub fn new(ticks: u32) -> Self

Create a new Instant from the given number of ticks

Trait Implementations

impl<const TICKS_PER_SEC: u32> Add<Duration> for Instant32<TICKS_PER_SEC>

fn add(self, other: Duration) -> Instant32<TICKS_PER_SEC>

Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See Instant::checked_add for a version without panic.

type Output = Instant32<TICKS_PER_SEC>

The resulting type after applying the + operator.

impl<const TICKS_PER_SEC: u32> AddAssign<Duration> for Instant32<TICKS_PER_SEC>

fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl<const TICKS_PER_SEC: u32> Clone for Instant32<TICKS_PER_SEC>

fn clone(&self) -> Instant32<TICKS_PER_SEC>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const TICKS_PER_SEC: u32> Debug for Instant32<TICKS_PER_SEC>

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

Formats the value using the given formatter.

impl<const TICKS_PER_SEC: u32> Hash for Instant32<TICKS_PER_SEC>

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<const TICKS_PER_SEC: u32> Instant for Instant32<TICKS_PER_SEC>

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

Returns the amount of time elapsed from another instant to this one, or None if that instant is later than this one.

fn checked_add(&self, duration: Duration) -> Option<Self>

Returns Some(t) where t is the time self + duration if t can be represented as Self (which means it’s inside the bounds of the underlying data structure), None otherwise.

fn checked_sub(&self, duration: Duration) -> Option<Self>

Returns Some(t) where t is the time self - duration if t can be represented as Instant (which means it’s inside the bounds of the underlying data structure), None otherwise.

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

Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.

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

Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.

impl<const TICKS_PER_SEC: u32> Ord for Instant32<TICKS_PER_SEC>

fn cmp(&self, other: &Instant32<TICKS_PER_SEC>) -> 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<const TICKS_PER_SEC: u32> PartialEq for Instant32<TICKS_PER_SEC>

fn eq(&self, other: &Instant32<TICKS_PER_SEC>) -> 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<const TICKS_PER_SEC: u32> PartialOrd for Instant32<TICKS_PER_SEC>

fn partial_cmp(&self, other: &Instant32<TICKS_PER_SEC>) -> 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<const TICKS_PER_SEC: u32> Sub<Duration> for Instant32<TICKS_PER_SEC>

type Output = Instant32<TICKS_PER_SEC>

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> Instant32<TICKS_PER_SEC>

Performs the - operation.

impl<const TICKS_PER_SEC: u32> Sub for Instant32<TICKS_PER_SEC>

fn sub(self, other: Instant32<TICKS_PER_SEC>) -> Duration

Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.

Panics

As in the current version of the Rust stdlib, this method saturates instead of panicking.

type Output = Duration

The resulting type after applying the - operator.

impl<const TICKS_PER_SEC: u32> SubAssign<Duration> for Instant32<TICKS_PER_SEC>

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl<const TICKS_PER_SEC: u32> Copy for Instant32<TICKS_PER_SEC>

impl<const TICKS_PER_SEC: u32> Eq for Instant32<TICKS_PER_SEC>

impl<const TICKS_PER_SEC: u32> StructuralPartialEq for Instant32<TICKS_PER_SEC>