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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
use std::{
    fmt,
    ops::{Add, AddAssign, Sub, SubAssign},
};

use serde::{Deserialize, Serialize};
use zbus::zvariant::{Error, Type, Value};

/// A time with microsecond precision which can be negative.
#[derive(
    Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize, Type,
)]
#[serde(transparent)]
#[doc(alias = "Time_In_Us")]
pub struct Time(i64);

impl fmt::Debug for Time {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}µs", self.0)
    }
}

impl Time {
    /// A time of zero.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// let time = Time::ZERO;
    /// assert!(time.is_zero());
    /// assert_eq!(time.as_micros(), 0);
    /// ```
    pub const ZERO: Self = Self::from_micros(0);

    /// The minimum time.
    pub const MIN: Self = Self::from_micros(i64::MIN);

    /// The maximum time.
    pub const MAX: Self = Self::from_micros(i64::MAX);

    /// Creates a new `Time` from the specified number of whole seconds.
    ///
    /// # Panics
    ///
    /// This will panic if the number of seconds overflows.
    ///
    /// # Examples
    ///  ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_secs(5).as_nanos(), 5_000_000_000);
    /// ```
    #[inline]
    pub const fn from_secs(secs: i64) -> Self {
        match secs.checked_mul(1_000_000) {
            Some(micros) => Self::from_micros(micros),
            None => panic!("overflow when creating time from seconds"),
        }
    }

    /// Creates a new `Time` from the specified number of whole milliseconds.
    ///
    /// # Panics
    ///
    /// This will panic if the number of milliseconds overflows.
    ///
    /// # Examples
    ///  ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_millis(5).as_nanos(), 5_000_000);
    /// ```
    #[inline]
    pub const fn from_millis(millis: i64) -> Self {
        match millis.checked_mul(1000) {
            Some(micros) => Self::from_micros(micros),
            None => panic!("overflow when creating time from milliseconds"),
        }
    }

    /// Creates a new `Time` from the specified number of whole microseconds.
    ///
    /// # Examples
    ///  ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_micros(5).as_nanos(), 5_000);
    /// ```
    #[inline]
    pub const fn from_micros(micros: i64) -> Self {
        Self(micros)
    }

    /// Creates a new `Time` from the specified number of whole nanoseconds.
    ///
    /// **Note:** This will round of the nanoseconds to microseconds level of
    /// precision.
    ///
    /// # Examples
    ///  ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_nanos(5).as_nanos(), 0);
    /// assert_eq!(Time::from_nanos(5342).as_nanos(), 5000);
    /// ```
    #[inline]
    pub const fn from_nanos(nanos: i64) -> Self {
        Self::from_micros(nanos / 1000)
    }

    /// Returns the number of *whole* seconds contained by this `Time`.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_micros(5_000_000).as_secs(), 5);
    /// assert_eq!(Time::from_micros(3).as_secs(), 0);
    /// ```
    #[inline]
    pub const fn as_secs(&self) -> i64 {
        self.as_micros() / 1_000_000
    }

    /// Returns the number of *whole* milliseconds contained by this `Time`.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_micros(5_000_000).as_millis(), 5_000);
    /// assert_eq!(Time::from_micros(3).as_millis(), 0);
    /// ```
    #[inline]
    pub const fn as_millis(&self) -> i64 {
        self.as_micros() / 1000
    }

    /// Returns the number of *whole* microseconds contained by this `Time`.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_micros(5_000_000).as_micros(), 5_000_000);
    /// assert_eq!(Time::from_micros(3).as_micros(), 3);
    /// ```
    #[inline]
    pub const fn as_micros(&self) -> i64 {
        self.0
    }

    /// Returns the number of *whole* nanoseconds contained by this `Time`.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::from_micros(5_000_000).as_nanos(), 5_000_000_000);
    /// assert_eq!(Time::from_micros(3).as_nanos(), 3_000);
    #[inline]
    pub const fn as_nanos(&self) -> i128 {
        self.as_micros() as i128 * 1000
    }

    /// Returns true if this `Time` is zero.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::ZERO.is_zero(), true);
    /// assert_eq!(Time::from_micros(1).is_zero(), false);
    /// ```
    #[inline]
    pub const fn is_zero(&self) -> bool {
        self.0 == 0
    }

    /// Returns true if this `Time` is negative.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::ZERO.is_negative(), false);
    /// assert_eq!(Time::from_micros(-1).is_negative(), true);
    /// assert_eq!(Time::from_micros(1).is_negative(), false);
    /// ```
    #[inline]
    pub const fn is_negative(&self) -> bool {
        self.0 < 0
    }

    /// Returns true if this `Time` is positive.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::ZERO.is_positive(), false);
    /// assert_eq!(Time::from_micros(1).is_positive(), true);
    /// assert_eq!(Time::from_micros(-1).is_positive(), false);
    /// ```
    #[inline]
    pub const fn is_positive(&self) -> bool {
        self.0 > 0
    }

    /// Returns the time as an absolute (non-negative) value.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(Time::ZERO.abs(), Time::ZERO);
    /// assert_eq!(Time::from_micros(-1).abs(), Time::from_micros(1));
    /// assert_eq!(Time::from_micros(1).abs(), Time::from_micros(1));
    /// ```
    #[inline]
    pub const fn abs(&self) -> Self {
        Self(self.0.abs())
    }

    /// Checked `Time` addition. Computes `self + other`, returning [`None`]
    /// if overflow occurred.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(
    ///     Time::from_micros(1).checked_add(Time::from_micros(1)),
    ///     Some(Time::from_micros(2))
    /// );
    /// assert_eq!(Time::MAX.checked_add(Time::from_micros(1)), None);
    /// ```
    #[inline]
    pub const fn checked_add(self, other: Self) -> Option<Self> {
        match self.0.checked_add(other.0) {
            Some(inner) => Some(Self(inner)),
            None => None,
        }
    }

    /// Checked `Time` subtraction. Computes `self - other`, returning [`None`]
    /// if overflow occurred.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(
    ///     Time::from_micros(2).checked_sub(Time::from_micros(1)),
    ///     Some(Time::from_micros(1))
    /// );
    /// assert_eq!(Time::MIN.checked_sub(Time::from_micros(1)), None);
    /// ```
    #[inline]
    pub const fn checked_sub(self, other: Self) -> Option<Self> {
        match self.0.checked_sub(other.0) {
            Some(inner) => Some(Self(inner)),
            None => None,
        }
    }

    /// Saturating `Time` addition. Computes `self + other`, returning
    /// [`Time::MAX`] if overflow occurred.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(
    ///     Time::from_micros(1).saturating_add(Time::from_micros(1)),
    ///     Time::from_micros(2)
    /// );
    /// assert_eq!(Time::MAX.saturating_add(Time::from_micros(1)), Time::MAX);
    /// ```
    #[inline]
    pub const fn saturating_add(self, other: Self) -> Self {
        match self.checked_add(other) {
            Some(inner) => inner,
            None => Self::MAX,
        }
    }

    /// Saturating `Time` subtraction. Computes `self - other`, returning
    /// [`Time::MIN`] if overflow occurred.
    ///
    /// # Examples
    /// ```
    /// use mpris_server::Time;
    ///
    /// assert_eq!(
    ///     Time::from_micros(2).saturating_sub(Time::from_micros(1)),
    ///     Time::from_micros(1)
    /// );
    /// assert_eq!(Time::MIN.saturating_sub(Time::from_micros(1)), Time::MIN);
    /// ```
    #[inline]
    pub const fn saturating_sub(self, other: Self) -> Self {
        match self.checked_sub(other) {
            Some(inner) => inner,
            None => Self::MIN,
        }
    }
}

impl Add for Time {
    type Output = Self;

    #[inline]
    fn add(self, other: Self) -> Self {
        self.checked_add(other).expect("overflow when adding times")
    }
}

impl AddAssign for Time {
    fn add_assign(&mut self, rhs: Self) {
        *self = *self + rhs;
    }
}

impl Sub for Time {
    type Output = Self;

    #[inline]
    fn sub(self, other: Self) -> Self {
        self.checked_sub(other)
            .expect("overflow when subtracting times")
    }
}

impl SubAssign for Time {
    fn sub_assign(&mut self, rhs: Self) {
        *self = *self - rhs;
    }
}

impl<'a> From<Time> for Value<'a> {
    fn from(time: Time) -> Self {
        Value::from(time.0)
    }
}

impl TryFrom<Value<'_>> for Time {
    type Error = Error;

    fn try_from(value: Value<'_>) -> Result<Self, Self::Error> {
        i64::try_from(value).map(Self)
    }
}

impl TryFrom<&Value<'_>> for Time {
    type Error = Error;

    fn try_from(value: &Value<'_>) -> Result<Self, Self::Error> {
        i64::try_from(value).map(Self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn valid_signature() {
        assert_eq!(Time::signature(), "x");
    }
}