clck 0.1.8

A responsive cross-platform countdown alarm for the terminal.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use std::time::{Duration, Instant};

#[derive(Clone, Copy, Debug)]
pub struct Countdown {
    duration: Duration,
    accumulated: Duration,
    resumed_at: Option<Instant>,
}

impl Countdown {
    pub fn new(started_at: Instant, duration: Duration) -> Self {
        Self {
            duration,
            accumulated: Duration::ZERO,
            resumed_at: Some(started_at),
        }
    }

    fn elapsed(&self, now: Instant) -> Duration {
        self.accumulated
            + self
                .resumed_at
                .map_or(Duration::ZERO, |t| now.duration_since(t))
    }

    pub fn remaining(&self, now: Instant) -> Duration {
        self.duration.saturating_sub(self.elapsed(now))
    }

    pub fn is_finished(&self, now: Instant) -> bool {
        self.remaining(now).is_zero()
    }

    pub fn pause(&mut self, now: Instant) {
        if let Some(resumed_at) = self.resumed_at.take() {
            self.accumulated += now.duration_since(resumed_at);
        }
    }

    pub fn resume(&mut self, now: Instant) {
        if self.resumed_at.is_none() {
            self.resumed_at = Some(now);
        }
    }

    pub fn is_paused(&self) -> bool {
        self.resumed_at.is_none()
    }
}

#[cfg(test)]
mod tests {
    use super::Countdown;
    use std::time::{Duration, Instant};

    #[test]
    fn remaining_time_never_underflows() {
        let start = Instant::now();
        let timer = Countdown::new(start, Duration::from_secs(90));
        assert_eq!(
            timer.remaining(start + Duration::from_secs(30)),
            Duration::from_secs(60)
        );
        assert_eq!(
            timer.remaining(start + Duration::from_secs(100)),
            Duration::ZERO
        );
    }

    #[test]
    fn pause_freezes_remaining_time() {
        let start = Instant::now();
        let mut timer = Countdown::new(start, Duration::from_secs(60));
        let paused_at = start + Duration::from_secs(10);
        timer.pause(paused_at);
        assert!(timer.is_paused());
        // Time should not advance while paused
        assert_eq!(
            timer.remaining(paused_at + Duration::from_secs(20)),
            Duration::from_secs(50)
        );
    }

    #[test]
    fn resume_continues_from_paused_remaining() {
        let start = Instant::now();
        let mut timer = Countdown::new(start, Duration::from_secs(60));
        timer.pause(start + Duration::from_secs(10));
        let resumed_at = start + Duration::from_secs(30);
        timer.resume(resumed_at);
        assert!(!timer.is_paused());
        // After resuming, 5 more seconds pass → remaining = 60 - 10 - 5 = 45
        assert_eq!(
            timer.remaining(resumed_at + Duration::from_secs(5)),
            Duration::from_secs(45)
        );
    }
}