Skip to main content

MockInstant

Struct MockInstant 

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

A monotonic instant measured from a crate::MockTimeline origin.

MockInstant is the deadline value used by crate::MockTimeline. It is intentionally monotonic and relative: it stores nanoseconds since a timeline origin, not a UTC timestamp. It also carries the id of the timeline that produced it through crate::MockTimeline::now.

Instants can be ordered and can be advanced with saturating_add, which is useful for computing relative deadlines. Ordering is defined only for instants from the same timeline. Passing an instant from one timeline to another timeline’s wait API is rejected with crate::MockTimeError::MismatchedTimeline.

Implementations§

Source§

impl MockInstant

Source

pub const fn timeline_id(&self) -> u64

Returns the id of the timeline that produced this instant.

§Returns

The source timeline id.

Source

pub const fn nanos_since_origin(&self) -> u128

Returns the instant offset from the timeline origin in nanoseconds.

§Returns

Nanoseconds since the mock timeline origin.

Source

pub fn saturating_add(self, duration: Duration) -> Self

Adds a relative duration, saturating at u128::MAX.

§Parameters
  • duration: Relative duration to add.
§Returns

The advanced mock instant.

Trait Implementations§

Source§

impl Clone for MockInstant

Source§

fn clone(&self) -> MockInstant

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MockInstant

Source§

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

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

impl Hash for MockInstant

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MockInstant

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl PartialOrd for MockInstant

Source§

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

Compares two instants only when they belong to the same timeline.

§Returns

Some(ordering) for instants from the same timeline, or None for instants from different timelines.

1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Copy for MockInstant

Source§

impl Eq for MockInstant

Source§

impl StructuralPartialEq for MockInstant

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.