use crate::prelude::*;
use core::fmt::{Display, Error as FmtError, Formatter};
use core::hash::{Hash, Hasher};
use core::num::ParseIntError;
use core::ops::{Add, Sub};
use core::str::FromStr;
use core::time::Duration;
use flex_error::{define_error, TraceError};
use serde_derive::{Deserialize, Serialize};
use tendermint::Time;
use time::OffsetDateTime;
pub const ZERO_DURATION: Duration = Duration::from_secs(0);
#[derive(PartialEq, Eq, Copy, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Timestamp {
time: Option<Time>,
}
#[allow(clippy::derive_hash_xor_eq)]
impl Hash for Timestamp {
fn hash<H: Hasher>(&self, state: &mut H) {
let odt: Option<OffsetDateTime> = self.time.map(Into::into);
odt.hash(state);
}
}
#[derive(PartialEq, Eq, Copy, Clone, Debug, Deserialize, Serialize, Hash)]
pub enum Expiry {
Expired,
NotExpired,
InvalidTimestamp,
}
impl Timestamp {
pub fn from_nanoseconds(nanoseconds: u64) -> Result<Timestamp, ParseTimestampError> {
if nanoseconds == 0 {
Ok(Timestamp { time: None })
} else {
let ts = OffsetDateTime::from_unix_timestamp_nanos(nanoseconds as i128)
.unwrap()
.try_into()
.unwrap();
Ok(Timestamp { time: Some(ts) })
}
}
#[cfg(feature = "clock")]
pub fn now() -> Timestamp {
Time::now().into()
}
pub fn none() -> Self {
Timestamp { time: None }
}
pub fn duration_since(&self, other: &Timestamp) -> Option<Duration> {
match (self.time, other.time) {
(Some(time1), Some(time2)) => time1.duration_since(time2).ok(),
_ => None,
}
}
#[deprecated(since = "0.9.1", note = "use `nanoseconds` instead")]
pub fn as_nanoseconds(&self) -> u64 {
(*self).nanoseconds()
}
pub fn nanoseconds(self) -> u64 {
self.time.map_or(0, |time| {
let t: OffsetDateTime = time.into();
let s = t.unix_timestamp_nanos();
assert!(s >= 0, "time {:?} has negative `.timestamp()`", time);
s.try_into().unwrap()
})
}
pub fn into_datetime(self) -> Option<OffsetDateTime> {
self.time.map(Into::into)
}
pub fn into_tm_time(self) -> Option<Time> {
self.time
}
pub fn check_expiry(&self, other: &Timestamp) -> Expiry {
match (self.time, other.time) {
(Some(time1), Some(time2)) => {
if time1 > time2 {
Expiry::Expired
} else {
Expiry::NotExpired
}
}
_ => Expiry::InvalidTimestamp,
}
}
pub fn after(&self, other: &Timestamp) -> bool {
match (self.time, other.time) {
(Some(time1), Some(time2)) => time1 > time2,
_ => false,
}
}
}
impl Display for Timestamp {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
write!(
f,
"Timestamp({})",
self.time
.map_or("NoTimestamp".to_string(), |time| time.to_rfc3339())
)
}
}
define_error! {
#[derive(Debug, PartialEq, Eq)]
TimestampOverflowError {
TimestampOverflow
|_| { "Timestamp overflow when modifying with duration" }
}
}
impl Add<Duration> for Timestamp {
type Output = Result<Timestamp, TimestampOverflowError>;
fn add(self, duration: Duration) -> Result<Timestamp, TimestampOverflowError> {
match self.time {
Some(time) => {
let time =
(time + duration).map_err(|_| TimestampOverflowError::timestamp_overflow())?;
Ok(Timestamp { time: Some(time) })
}
None => Ok(self),
}
}
}
impl Sub<Duration> for Timestamp {
type Output = Result<Timestamp, TimestampOverflowError>;
fn sub(self, duration: Duration) -> Result<Timestamp, TimestampOverflowError> {
match self.time {
Some(time) => {
let time =
(time - duration).map_err(|_| TimestampOverflowError::timestamp_overflow())?;
Ok(Timestamp { time: Some(time) })
}
None => Ok(self),
}
}
}
define_error! {
#[derive(Debug, PartialEq, Eq)]
ParseTimestampError {
ParseInt
[ TraceError<ParseIntError> ]
| _ | { "error parsing u64 integer from string"},
}
}
impl FromStr for Timestamp {
type Err = ParseTimestampError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let nanoseconds = u64::from_str(s).map_err(ParseTimestampError::parse_int)?;
Timestamp::from_nanoseconds(nanoseconds)
}
}
impl From<Time> for Timestamp {
fn from(tendermint_time: Time) -> Timestamp {
Timestamp {
time: Some(tendermint_time),
}
}
}
#[cfg(test)]
mod tests {
use time::OffsetDateTime;
use core::time::Duration;
use std::thread::sleep;
use test_log::test;
use super::{Expiry, Timestamp, ZERO_DURATION};
#[test]
fn test_timestamp_comparisons() {
let nil_timestamp = Timestamp::from_nanoseconds(0).unwrap();
assert_eq!(nil_timestamp.time, None);
assert_eq!(nil_timestamp.nanoseconds(), 0);
let timestamp1 = Timestamp::from_nanoseconds(1).unwrap();
let dt: OffsetDateTime = timestamp1.time.unwrap().into();
assert_eq!(dt.unix_timestamp_nanos(), 1);
assert_eq!(timestamp1.nanoseconds(), 1);
let timestamp2 = Timestamp::from_nanoseconds(1_000_000_000).unwrap();
let dt: OffsetDateTime = timestamp2.time.unwrap().into();
assert_eq!(dt.unix_timestamp_nanos(), 1_000_000_000);
assert_eq!(timestamp2.nanoseconds(), 1_000_000_000);
assert!(Timestamp::from_nanoseconds(u64::MAX).is_ok());
assert!(Timestamp::from_nanoseconds(i64::MAX.try_into().unwrap()).is_ok());
assert_eq!(timestamp1.check_expiry(×tamp2), Expiry::NotExpired);
assert_eq!(timestamp1.check_expiry(×tamp1), Expiry::NotExpired);
assert_eq!(timestamp2.check_expiry(×tamp2), Expiry::NotExpired);
assert_eq!(timestamp2.check_expiry(×tamp1), Expiry::Expired);
assert_eq!(
timestamp1.check_expiry(&nil_timestamp),
Expiry::InvalidTimestamp
);
assert_eq!(
nil_timestamp.check_expiry(×tamp2),
Expiry::InvalidTimestamp
);
assert_eq!(
nil_timestamp.check_expiry(&nil_timestamp),
Expiry::InvalidTimestamp
);
}
#[test]
fn test_timestamp_arithmetic() {
let time0 = Timestamp::none();
let time1 = Timestamp::from_nanoseconds(100).unwrap();
let time2 = Timestamp::from_nanoseconds(150).unwrap();
let time3 = Timestamp::from_nanoseconds(50).unwrap();
let duration = Duration::from_nanos(50);
assert_eq!(time1, (time1 + ZERO_DURATION).unwrap());
assert_eq!(time2, (time1 + duration).unwrap());
assert_eq!(time3, (time1 - duration).unwrap());
assert_eq!(time0, (time0 + duration).unwrap());
assert_eq!(time0, (time0 - duration).unwrap());
}
#[test]
fn subtract_compare() {
let sleep_duration = Duration::from_micros(100);
let start = Timestamp::now();
sleep(sleep_duration);
let end = Timestamp::now();
let res = end.duration_since(&start);
assert!(res.is_some());
let inner = res.unwrap();
assert!(inner > sleep_duration);
}
}