Skip to main content

Instant

Struct Instant 

Source
pub struct Instant<Clock>
where Clock: Clock,
{ /* private fields */ }
Expand description

A measurement of a monotonically non-decreasing clock.

An Instant is generic over a Clock, preventing arithmetic operations between instants of different clocks at compile-time.

Implementations§

Source§

impl<Clock> Instant<Clock>
where Clock: Clock,

Source

pub const MAX: Instant<Clock>

The maximum possible value for an Instant.

Source

pub const MIN: Instant<Clock>

The minimum possible value for an Instant.

Source

pub const fn from_ticks(ticks: u64) -> Instant<Clock>

Creates a new Instant from a raw tick count.

Source

pub const fn ticks(&self) -> u64

Returns the raw tick count of this Instant.

Source

pub const fn checked_add_duration( self, duration: Duration<Clock>, ) -> Option<Instant<Clock>>

Returns the Instant resulting from adding Duration, or None if overflow occurred.

Source

pub const fn checked_sub_duration( self, duration: Duration<Clock>, ) -> Option<Instant<Clock>>

Returns the Instant resulting from subtracting Duration, or None if underflow occurred.

Trait Implementations§

Source§

impl<Clock> Add<Duration<Clock>> for Instant<Clock>
where Clock: Clock,

Source§

type Output = Instant<Clock>

The resulting type after applying the + operator.
Source§

fn add( self, rhs: Duration<Clock>, ) -> <Instant<Clock> as Add<Duration<Clock>>>::Output

Performs the + operation. Read more
Source§

impl<Clock> Clone for Instant<Clock>
where Clock: Clock,

Source§

fn clone(&self) -> Instant<Clock>

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<Clock> Debug for Instant<Clock>
where Clock: Debug + Clock,

Source§

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

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

impl<Clock> Ord for Instant<Clock>
where Clock: Clock,

Source§

fn cmp(&self, other: &Instant<Clock>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<Clock> PartialEq for Instant<Clock>
where Clock: Clock,

Source§

fn eq(&self, other: &Instant<Clock>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<Clock> PartialOrd for Instant<Clock>
where Clock: Clock,

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · 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 · 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 · 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 · 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<Clock> Sub<Duration<Clock>> for Instant<Clock>
where Clock: Clock,

Source§

type Output = Instant<Clock>

The resulting type after applying the - operator.
Source§

fn sub( self, rhs: Duration<Clock>, ) -> <Instant<Clock> as Sub<Duration<Clock>>>::Output

Performs the - operation. Read more
Source§

impl<Clock> Sub for Instant<Clock>
where Clock: Clock,

Source§

type Output = Duration<Clock>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Instant<Clock>) -> <Instant<Clock> as Sub>::Output

Performs the - operation. Read more
Source§

impl<Clock> Copy for Instant<Clock>
where Clock: Clock,

Source§

impl<Clock> Eq for Instant<Clock>
where Clock: Clock,

Auto Trait Implementations§

§

impl<Clock> Freeze for Instant<Clock>

§

impl<Clock> RefUnwindSafe for Instant<Clock>
where Clock: RefUnwindSafe,

§

impl<Clock> Send for Instant<Clock>
where Clock: Send,

§

impl<Clock> Sync for Instant<Clock>
where Clock: Sync,

§

impl<Clock> Unpin for Instant<Clock>
where Clock: Unpin,

§

impl<Clock> UnsafeUnpin for Instant<Clock>

§

impl<Clock> UnwindSafe for Instant<Clock>
where Clock: UnwindSafe,

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.