Struct rubble::time::Instant

pub struct Instant(_);

A point in time, relative to an unspecfied epoch.

This has microsecond resolution and may wrap around after >1 hour. Apart from the wraparound, it is monotonic.

Instants are obtained from an implementation of Timer. Instants created from different Timer instances (even when using the same implementation) are not compatible, and mixing them in operations causes unspecified results. Durations are independent of the Timer implementation and thus can be mixed freely.

Methods

impl Instant

pub const MAX_TIME_BETWEEN: Duration

The maximum time between two Instants that can be handled by Instant::duration_since.

This is defined to be a value of a few minutes, intended to be sufficient for the BLE stack.

pub fn from_raw_micros(micros: u32) -> Self

Creates an Instant from raw microseconds since an arbitrary implementation-defined reference point.

This should only be called from a Timer implementation.

pub fn raw_micros(&self) -> u32

Returns the raw value from which this Instant was created.

This should only be called from a Timer implementation.

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

Calculates the duration of time that has passed between earlier and self.

The maximum duration that can be calculated by this method is defined as MAX_TIME_BETWEEN. Calling this method when the Instants are further apart is an error and may panic. This is done as a safeguard, since Instants can wrap around, which can cause the result of this function to be incorrect. It does not prevent that from happening, but makes unexpected durations show up much earlier.

Both self and earlier must have been created by the same Timer, or the result of this function will be unspecified.

Trait Implementations

impl Copy for Instant

impl Display for Instant

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

Formats the value using the given formatter.

impl Debug for Instant

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

Formats the value using the given formatter.

impl Add<Duration> for Instant

A Duration can be added to an Instant, moving the Instant forwards in time.

type Output = Self

The resulting type after applying the + operator.

fn add(self, d: Duration) -> Self

Performs the + operation.

impl Sub<Instant> for Instant

Instants can be subtracted, which computes the Duration between the rhs and lhs using Instant::duration_since.

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for Instant

A Duration can be subtracted from an Instant, moving the Instant backwards in time.

type Output = Self

The resulting type after applying the - operator.

fn sub(self, d: Duration) -> Self

Performs the - operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, d: Duration)

Performs the += operation.

impl SubAssign<Duration> for Instant

Subtracts a Duration from self.

fn sub_assign(&mut self, d: Duration)

Performs the -= operation.

impl Clone for Instant

fn clone(&self) -> Instant

Returns a copy of the value.

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

Performs copy-assignment from source.