use core::fmt;
use std::time::{Duration, Instant};
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Deadline(Instant);
impl Deadline {
pub fn at(instant: Instant) -> Self {
Deadline(instant)
}
pub fn after(duration: Duration) -> Self {
Deadline(Instant::now() + duration)
}
pub fn instant(&self) -> Instant {
self.0
}
pub fn remaining(&self) -> Duration {
self.0.saturating_duration_since(Instant::now())
}
pub fn is_expired(&self) -> bool {
self.remaining() == Duration::ZERO
}
pub fn min(self, other: Deadline) -> Deadline {
Deadline(self.0.min(other.0))
}
pub fn less(self, duration: Duration) -> Deadline {
Deadline(self.0.checked_sub(duration).unwrap_or_else(Instant::now))
}
}
impl From<Instant> for Deadline {
fn from(instant: Instant) -> Self {
Deadline(instant)
}
}
impl fmt::Display for Deadline {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let remaining = self.remaining();
if remaining == Duration::ZERO {
f.write_str("deadline expired")
} else {
write!(f, "deadline in {remaining:?}")
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_future_deadline_is_not_expired() {
let deadline = Deadline::after(Duration::from_secs(60));
assert!(!deadline.is_expired());
assert!(deadline.remaining() > Duration::from_secs(30));
assert!(deadline.remaining() <= Duration::from_secs(60));
}
#[test]
fn a_zero_deadline_is_immediately_expired() {
let deadline = Deadline::after(Duration::ZERO);
assert!(deadline.is_expired());
assert_eq!(deadline.remaining(), Duration::ZERO);
}
#[test]
fn remaining_saturates_instead_of_underflowing() {
let Some(long_past) = Instant::now().checked_sub(Duration::from_secs(3600)) else {
return;
};
let deadline = Deadline::at(long_past);
assert!(deadline.is_expired());
assert_eq!(deadline.remaining(), Duration::ZERO);
}
#[test]
fn a_deadline_expires_once_its_time_passes() {
let deadline = Deadline::after(Duration::from_millis(20));
assert!(!deadline.is_expired());
std::thread::sleep(Duration::from_millis(40));
assert!(deadline.is_expired());
}
#[test]
fn min_picks_the_binding_deadline() {
let soon = Deadline::after(Duration::from_secs(1));
let later = Deadline::after(Duration::from_secs(600));
assert_eq!(soon.min(later), soon);
assert_eq!(later.min(soon), soon);
}
#[test]
fn less_saturates_at_now_rather_than_panicking() {
let deadline = Deadline::after(Duration::from_millis(1));
let impossible = deadline.less(Duration::from_secs(86_400));
assert!(impossible.is_expired());
}
#[test]
fn ordering_follows_time() {
let soon = Deadline::after(Duration::from_secs(1));
let later = Deadline::after(Duration::from_secs(2));
assert!(soon < later);
}
}