Struct coarsetime::Instant

source · [−]

pub struct Instant(_);

Expand description

A measurement of a monotonically increasing clock. Opaque and useful only with Duration.

Implementations

impl Instant

pub fn now() -> Instant

Returns an instant corresponding to “now”

This function also updates the stored instant.

pub fn recent() -> Instant

Returns an instant corresponding to the latest update

pub fn update()

Update the stored instant

This function should be called frequently, for example in an event loop or using an Updater task.

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

Returns the amount of time elapsed from another instant to this one

pub fn elapsed_since_recent(&self) -> Duration

Returns the amount of time elapsed between the this instant was created and the latest update

pub fn elapsed(&self) -> Duration

Returns the amount of time elapsed since this instant was created

This function also updates the stored instant.

pub fn as_ticks(&self) -> u64

Return a representation of this instant as a number of “ticks”.

Note that length of a ‘tick’ is not guaranteed to represent the same amount of time across different platforms, or from one version of coarsetime to another.

Note also that the instant represented by “0” ticks is unspecified. It is not guaranteed to be the same time across different platforms, or from one version of coarsetime to another.

This API is mainly intended for applications that need to store the value of an Instant in an AtomicU64.

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Instant

Performs the + operation. Read more

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more

impl Clone for Instant

fn clone(&self) -> Instant

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Instant

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

Formats the value using the given formatter. Read more

impl Default for Instant

fn default() -> Instant

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

impl Hash for Instant

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,

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

impl Ord for Instant

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl PartialEq<Instant> for Instant

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl PartialOrd<Instant> for Instant

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

This method 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

This method 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

This method 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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Sub<Duration> for Instant

type Output = Instant

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Instant

Performs the - operation. Read more

impl Sub<Instant> for Instant

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: Instant) -> Duration

Performs the - operation. Read more

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more

impl Copy for Instant

impl Eq for Instant

impl StructuralEq for Instant

impl StructuralPartialEq for Instant

Auto Trait Implementations

impl RefUnwindSafe for Instant

impl Send for Instant

impl Sync for Instant

impl Unpin for Instant

impl UnwindSafe for Instant

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.