2020-10-26 12:39:53 +01:00
|
|
|
use core::fmt;
|
2020-10-31 16:37:34 +01:00
|
|
|
use core::ops::{Add, AddAssign, Sub, SubAssign};
|
2020-10-19 21:15:24 +02:00
|
|
|
|
2021-08-03 22:08:13 +02:00
|
|
|
use super::{driver, Duration, TICKS_PER_SECOND};
|
2020-10-19 21:15:24 +02:00
|
|
|
|
2020-12-01 17:46:56 +01:00
|
|
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
|
|
|
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
2021-03-22 00:45:53 +01:00
|
|
|
/// An Instant in time, based on the MCU's clock ticks since startup.
|
2020-10-19 21:15:24 +02:00
|
|
|
pub struct Instant {
|
|
|
|
ticks: u64,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Instant {
|
2020-12-26 23:44:53 +01:00
|
|
|
pub const MIN: Instant = Instant { ticks: u64::MIN };
|
|
|
|
pub const MAX: Instant = Instant { ticks: u64::MAX };
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Returns an Instant representing the current time.
|
2020-10-19 21:15:24 +02:00
|
|
|
pub fn now() -> Instant {
|
2021-08-03 22:08:13 +02:00
|
|
|
Instant {
|
|
|
|
ticks: driver::now(),
|
|
|
|
}
|
2020-10-19 21:15:24 +02:00
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant as clock ticks since MCU start.
|
2020-10-19 21:21:43 +02:00
|
|
|
pub const fn from_ticks(ticks: u64) -> Self {
|
|
|
|
Self { ticks }
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant as milliseconds since MCU start.
|
2020-10-26 12:39:53 +01:00
|
|
|
pub const fn from_millis(millis: u64) -> Self {
|
|
|
|
Self {
|
|
|
|
ticks: millis * TICKS_PER_SECOND as u64 / 1000,
|
|
|
|
}
|
|
|
|
}
|
2021-03-22 01:01:13 +01:00
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant representing seconds since MCU start.
|
2020-10-26 12:39:53 +01:00
|
|
|
pub const fn from_secs(seconds: u64) -> Self {
|
|
|
|
Self {
|
|
|
|
ticks: seconds * TICKS_PER_SECOND as u64,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant as ticks since MCU start.
|
|
|
|
|
2020-10-26 12:39:53 +01:00
|
|
|
pub const fn as_ticks(&self) -> u64 {
|
2020-10-19 21:15:24 +02:00
|
|
|
self.ticks
|
|
|
|
}
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant as seconds since MCU start.
|
2020-10-19 21:15:24 +02:00
|
|
|
|
2020-10-26 12:39:53 +01:00
|
|
|
pub const fn as_secs(&self) -> u64 {
|
|
|
|
self.ticks / TICKS_PER_SECOND as u64
|
|
|
|
}
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Instant as miliseconds since MCU start.
|
2020-10-26 12:39:53 +01:00
|
|
|
|
|
|
|
pub const fn as_millis(&self) -> u64 {
|
|
|
|
self.ticks * 1000 / TICKS_PER_SECOND as u64
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Duration between this Instant and another Instant
|
|
|
|
/// Panics on over/underflow.
|
2020-10-19 21:15:24 +02:00
|
|
|
pub fn duration_since(&self, earlier: Instant) -> Duration {
|
|
|
|
Duration {
|
2021-02-14 01:41:36 +01:00
|
|
|
ticks: self.ticks.checked_sub(earlier.ticks).unwrap(),
|
2020-10-19 21:15:24 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Duration between this Instant and another Instant
|
2020-10-19 21:15:24 +02:00
|
|
|
pub fn checked_duration_since(&self, earlier: Instant) -> Option<Duration> {
|
|
|
|
if self.ticks < earlier.ticks {
|
|
|
|
None
|
|
|
|
} else {
|
|
|
|
Some(Duration {
|
2021-02-14 01:41:36 +01:00
|
|
|
ticks: self.ticks - earlier.ticks,
|
2020-10-19 21:15:24 +02:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Returns the duration since the "earlier" Instant.
|
|
|
|
/// If the "earlier" instant is in the future, the duration is set to zero.
|
2020-10-19 21:15:24 +02:00
|
|
|
pub fn saturating_duration_since(&self, earlier: Instant) -> Duration {
|
|
|
|
Duration {
|
|
|
|
ticks: if self.ticks < earlier.ticks {
|
|
|
|
0
|
|
|
|
} else {
|
2021-02-14 01:41:36 +01:00
|
|
|
self.ticks - earlier.ticks
|
2020-10-19 21:15:24 +02:00
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-22 00:45:53 +01:00
|
|
|
/// Duration elapsed since this Instant.
|
2020-10-19 21:15:24 +02:00
|
|
|
pub fn elapsed(&self) -> Duration {
|
|
|
|
Instant::now() - *self
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn checked_add(&self, duration: Duration) -> Option<Instant> {
|
|
|
|
self.ticks
|
2021-02-14 01:41:36 +01:00
|
|
|
.checked_add(duration.ticks)
|
2020-10-19 21:15:24 +02:00
|
|
|
.map(|ticks| Instant { ticks })
|
|
|
|
}
|
|
|
|
pub fn checked_sub(&self, duration: Duration) -> Option<Instant> {
|
|
|
|
self.ticks
|
2021-02-14 01:41:36 +01:00
|
|
|
.checked_sub(duration.ticks)
|
2020-10-19 21:15:24 +02:00
|
|
|
.map(|ticks| Instant { ticks })
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Add<Duration> for Instant {
|
|
|
|
type Output = Instant;
|
|
|
|
|
|
|
|
fn add(self, other: Duration) -> Instant {
|
|
|
|
self.checked_add(other)
|
|
|
|
.expect("overflow when adding duration to instant")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl AddAssign<Duration> for Instant {
|
|
|
|
fn add_assign(&mut self, other: Duration) {
|
|
|
|
*self = *self + other;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Sub<Duration> for Instant {
|
|
|
|
type Output = Instant;
|
|
|
|
|
|
|
|
fn sub(self, other: Duration) -> Instant {
|
|
|
|
self.checked_sub(other)
|
|
|
|
.expect("overflow when subtracting duration from instant")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl SubAssign<Duration> for Instant {
|
|
|
|
fn sub_assign(&mut self, other: Duration) {
|
|
|
|
*self = *self - other;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Sub<Instant> for Instant {
|
|
|
|
type Output = Duration;
|
|
|
|
|
|
|
|
fn sub(self, other: Instant) -> Duration {
|
|
|
|
self.duration_since(other)
|
|
|
|
}
|
|
|
|
}
|
2020-10-26 12:39:53 +01:00
|
|
|
|
|
|
|
impl<'a> fmt::Display for Instant {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(f, "{} ticks", self.ticks)
|
|
|
|
}
|
|
|
|
}
|