tomate 0.5.0

A command-line tool for the Pomodoro productivity system
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

#[doc(hidden)]
pub mod datetime;
#[doc(hidden)]
pub mod datetimeopt;
#[doc(hidden)]
pub mod duration;

use chrono::{prelude::*, TimeDelta};
use serde::{Deserialize, Serialize};

/// Like a kitchen timer
#[derive(Clone, Eq, PartialEq, Hash, Debug, Serialize, Deserialize)]
pub struct Timer {
    #[serde(with = "crate::time::datetime::unix")]
    started_at: DateTime<Local>,
    #[serde(with = "crate::time::duration::seconds")]
    duration: TimeDelta,
}

impl Timer {
    /// Create a new timer
    pub fn new(started_at: DateTime<Local>, duration: TimeDelta) -> Self {
        Self {
            started_at,
            duration,
        }
    }

    /// Get the time this timer starts at
    pub fn starts_at(&self) -> DateTime<Local> {
        self.started_at
    }

    /// Get the time this timer ends at
    pub fn ends_at(&self) -> DateTime<Local> {
        self.started_at + self.duration
    }

    /// Get the length of time that this timer was set for
    pub fn duration(&self) -> TimeDelta {
        self.duration
    }

    /// Get the amount of time that has passed since this timer started
    pub fn elapsed(&self, now: DateTime<Local>) -> TimeDelta {
        (now - self.started_at).clamp(TimeDelta::zero(), self.duration)
    }

    /// Get the amount of time left on this timer
    pub fn remaining(&self, now: DateTime<Local>) -> TimeDelta {
        (self.duration - self.elapsed(now)).clamp(TimeDelta::zero(), self.duration)
    }

    /// Check if this timer's duration has run out
    pub fn done(&self, now: DateTime<Local>) -> bool {
        now > self.ends_at()
    }
}