timeout-trait 0.8.1

Traits used to wait and timeout.
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
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

use crate::*;
use core::{cmp::Ordering, marker::PhantomData, ops};

#[derive(Clone, Copy)]
pub struct TickDuration<T: TickInstant> {
    ticks: u64,
    _t: PhantomData<T>,
}

impl<T: TickInstant> TickDuration<T> {
    pub const ZERO: Self = Self::from_ticks(0);
    pub const MAX: Self = Self::from_ticks(u64::MAX);

    #[inline]
    pub const fn from_ticks(ticks: u64) -> Self {
        Self {
            ticks,
            _t: PhantomData,
        }
    }

    #[inline]
    pub const fn as_ticks(&self) -> u64 {
        self.ticks
    }

    pub fn nanos(timeout: u32) -> Self {
        let ns = timeout as u64;
        Self::from_ticks((ns * T::frequency().to_kHz() as u64).div_ceil(1_000_000))
    }

    pub fn as_nanos(&self) -> u32 {
        if let Some(t) = self.ticks.checked_mul(1_000_000) {
            let rst = t.div_ceil(T::frequency().to_kHz() as u64);
            if rst <= u32::MAX as u64 {
                return rst as u32;
            }
        }
        panic!();
    }

    pub fn micros(timeout: u32) -> Self {
        let us = timeout as u64;
        Self::from_ticks((us * T::frequency().to_kHz() as u64).div_ceil(1_000))
    }

    pub fn as_micros(&self) -> u32 {
        if let Some(t) = self.ticks.checked_mul(1_000) {
            let rst = t.div_ceil(T::frequency().to_kHz() as u64);
            if rst <= u32::MAX as u64 {
                return rst as u32;
            }
        }
        panic!();
    }

    pub fn millis(timeout: u32) -> Self {
        let ms = timeout as u64;
        Self::from_ticks(ms * T::frequency().to_kHz() as u64)
    }

    pub fn as_millis(&self) -> u32 {
        let rst = self.ticks.div_ceil(T::frequency().to_kHz() as u64);
        if rst <= u32::MAX as u64 {
            return rst as u32;
        }
        panic!();
    }

    #[inline]
    pub const fn is_zero(&self) -> bool {
        self.ticks == 0
    }
}

impl<T: TickInstant> PartialEq<Self> for TickDuration<T> {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.ticks.eq(&other.ticks)
    }
}

impl<T: TickInstant> PartialOrd<Self> for TickDuration<T> {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.ticks.partial_cmp(&other.ticks)
    }
}

impl<T: TickInstant> ops::Add<Self> for &TickDuration<T> {
    type Output = TickDuration<T>;
    #[inline]
    fn add(self, rhs: Self) -> Self::Output {
        TickDuration::from_ticks(self.ticks.saturating_add(rhs.ticks))
    }
}

impl<T: TickInstant> ops::Sub<Self> for &TickDuration<T> {
    type Output = TickDuration<T>;
    #[inline]
    fn sub(self, rhs: Self) -> Self::Output {
        TickDuration::from_ticks(self.ticks.saturating_sub(rhs.ticks))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::mock::MockInstant;
    type Duration = TickDuration<MockInstant>;

    #[test]
    fn duration() {
        let d = Duration::nanos(123);
        assert_eq!(d.as_nanos(), 123);

        let d = Duration::nanos(123_000);
        assert_eq!(d.as_nanos(), 123_000);

        let d = Duration::micros(5234);
        assert_eq!(d.as_micros(), 5234);

        let d = Duration::millis(472);
        assert_eq!(d.as_millis(), 472);

        let d = Duration::micros(123);
        assert_eq!(d.as_millis(), 1);
    }
}