Struct Instant 

pub struct Instant { /* private fields */ }

An Instant in time, based on the MCU’s clock ticks since startup.

Implementations

impl Instant

pub const MIN: Instant

The smallest (earliest) value that can be represented by the Instant type.

pub const MAX: Instant

The largest (latest) value that can be represented by the Instant type.

pub fn now() -> Instant

Returns an Instant representing the current time.

pub const fn from_ticks(ticks: u64) -> Self

Create an Instant from a tick count since system boot.

pub const fn from_nanos(nanos: u64) -> Self

Create an Instant from a nanosecond count since system boot.

pub const fn from_micros(micros: u64) -> Self

Create an Instant from a microsecond count since system boot.

pub const fn from_millis(millis: u64) -> Self

Create an Instant from a millisecond count since system boot.

pub const fn from_secs(seconds: u64) -> Self

Create an Instant from a second count since system boot.

pub const fn try_from_nanos(nanos: u64) -> Option<Self>

Try to create an Instant from a nanosecond count since system boot. Fails if the number of nanoseconds is too large.

pub const fn try_from_micros(micros: u64) -> Option<Self>

Try to create an Instant from a microsecond count since system boot. Fails if the number of microseconds is too large.

pub const fn try_from_millis(millis: u64) -> Option<Self>

Try to create an Instant from a millisecond count since system boot. Fails if the number of milliseconds is too large.

pub const fn try_from_secs(seconds: u64) -> Option<Self>

Try to create an Instant from a second count since system boot. Fails if the number of seconds is too large.

pub const fn as_ticks(&self) -> u64

Tick count since system boot.

pub const fn as_secs(&self) -> u64

Seconds since system boot.

pub const fn as_millis(&self) -> u64

Milliseconds since system boot.

pub const fn as_micros(&self) -> u64

Microseconds since system boot.

pub const fn as_nanos(&self) -> u64

Nanoseconds since system boot.

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

Duration between this Instant and another Instant

Panics

Panics if the computed duration overflows. Avoid panics with Instant::checked_duration_since() or Instant::saturating_duration_since().

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

Duration between this Instant and another Instant

This is a panic-free Instant::duration_since().

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

Returns the duration since the “earlier” Instant. If the “earlier” instant is in the future, the duration is set to zero.

This is a panic-free alternative to Instant::duration_since().

pub fn elapsed(&self) -> Duration

Duration elapsed since this Instant.

Panics

Panics if the computed duration overflows.

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

Adds one Duration to self, returning a new Instant or None in the event of an overflow.

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

Subtracts one Duration to self, returning a new Instant or None in the event of an overflow.

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

Adds a Duration to self. In case of overflow, the maximum value is returned.

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

Subtracts a Duration from self. In case of overflow, the minimum value is returned.

Trait Implementations

impl Add<Duration> for Instant

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

Computes Instant + Duration.

Panics

Panics if the computed instant overflows.

type Output = Instant

The resulting type after applying the + operator.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, other: Duration)

Computes Instant += Duration.

Panics

Panics if the computed instant overflows.

impl Clone for Instant

fn clone(&self) -> Instant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instant

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

Formats the value using the given formatter.

impl<'a> Display for Instant

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

Formats the value using the given formatter.

impl Format for Instant

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Ord for Instant

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

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

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

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

Computes Instant - Duration.

Panics

Panics if the computed instant overflows.

type Output = Instant

The resulting type after applying the - operator.

impl Sub for Instant

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

Computes Instant - Instant.

Panics

Panics if the computed duration overflows in Instant::duration_since.

type Output = Duration

The resulting type after applying the - operator.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, other: Duration)

Computes Instant -= Duration.

Panics

Panics if the computed instant overflows.

impl Copy for Instant

impl Eq for Instant

impl StructuralPartialEq for Instant