Struct Instant

pub struct Instant(/* private fields */);

Represents an instant in time.

Implementations

impl Instant

pub const EPOCH: Instant

Represents the moment the system booted.

pub fn now() -> Self

Returns the current instant.

The counter won’t measure time in sleep-mode.

The timer has a 1 microsecond resolution and will wrap after 36_558 years

Example

use esp_hal::time::Instant;
let now = Instant::now();

pub fn duration_since_epoch(&self) -> Duration

Returns the elapsed Duration since boot.

Example

use esp_hal::time::Instant;
let now = Instant::now();
let duration = now.duration_since_epoch();

pub fn elapsed(&self) -> Duration

Returns the elapsed Duration since this Instant was created.

Example

use esp_hal::time::Instant;
let now = Instant::now();
let duration = now.elapsed();

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: 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.

impl Debug for Instant

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

Formats the value using the given formatter.

impl Display for Instant

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

Formats the value using the given formatter.

impl Hash for Instant

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

Feeds this value into the given [Hasher].

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

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

type Output = Instant

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Instant

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl Copy for Instant

impl Eq for Instant

impl StructuralPartialEq for Instant