embassy-time

Crates

git

Versions

default

Flavors

embassy_time

Struct Instant

Source
pub struct Instant { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Instant

Source

pub const MIN: Instant = _

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

Source

pub const MAX: Instant = _

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

Source

pub fn now() -> Instant

Returns an Instant representing the current time.

Source

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

Create an Instant from a tick count since system boot.

Source

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

Create an Instant from a microsecond count since system boot.

Source

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

Create an Instant from a millisecond count since system boot.

Source

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

Create an Instant from a second count since system boot.

Source

pub const fn as_ticks(&self) -> u64

Tick count since system boot.

Source

pub const fn as_secs(&self) -> u64

Seconds since system boot.

Source

pub const fn as_millis(&self) -> u64

Milliseconds since system boot.

Source

pub const fn as_micros(&self) -> u64

Microseconds since system boot.

Source

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

Duration between this Instant and another Instant Panics on over/underflow.

Source

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

Duration between this Instant and another Instant

Source

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.

Source

pub fn elapsed(&self) -> Duration

Duration elapsed since this Instant.

Source

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.

Source

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.

Trait Implementations§

Source§

impl Add<Duration> for Instant

Source§

type Output = Instant

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl AddAssign<Duration> for Instant

Source§

fn add_assign(&mut self, other: Duration)

Performs the += operation. Read more
Source§

impl Clone for Instant

Source§

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
Source§

impl Debug for Instant

Source§

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

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

impl<'a> Display for Instant

Source§

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

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

impl Format for Instant

Source§

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

Writes the defmt representation of self to fmt.
Source§

impl Ord for Instant

Source§

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
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 PartialEq for Instant

Source§

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

Source§

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

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 Sub<Duration> for Instant

Source§

type Output = Instant

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl Sub for Instant

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl SubAssign<Duration> for Instant

Source§

fn sub_assign(&mut self, other: Duration)

Performs the -= operation. Read more
Source§

impl Copy for Instant

Source§

impl Eq for Instant

Source§

impl StructuralPartialEq for Instant

Auto Trait Implementations§

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.