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

use crate::*;
use core::marker::PhantomData;

/// [`DelayNs`] implementation
pub struct TickDelay<T> {
    _t: PhantomData<T>,
}

impl<T> Default for TickDelay<T>
where
    T: TickInstant,
{
    fn default() -> Self {
        Self { _t: PhantomData }
    }
}

impl<T> DelayNs for TickDelay<T>
where
    T: TickInstant,
{
    #[inline]
    fn delay_ns(&mut self, ns: u32) {
        let mut t = T::now();
        let dur = TickDuration::<T>::nanos(ns);
        while !t.timeout(&dur) {
            // For unit test
            #[cfg(feature = "std")]
            std::thread::sleep(std::time::Duration::from_nanos(1));
        }
    }
}

#[cfg(feature = "std")]
pub use for_std::*;
#[cfg(feature = "std")]
mod for_std {
    use super::*;
    use std::time::Duration;

    #[derive(Default)]
    pub struct StdDelayNs {}

    impl DelayNs for StdDelayNs {
        #[inline]
        fn delay_ns(&mut self, ns: u32) {
            std::thread::sleep(Duration::from_nanos(ns.into()))
        }
    }

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

        fn test_delay(mut d: impl DelayNs) {
            let t = Instant::now();
            d.delay_ns(200_000_000);
            let elapsed = t.elapsed();
            assert!(elapsed - Duration::from_millis(200) < Duration::from_millis(100));

            let t = Instant::now();
            d.delay_us(200_000);
            let elapsed = t.elapsed();
            assert!(elapsed - Duration::from_millis(200) < Duration::from_millis(100));

            let t = Instant::now();
            d.delay_ms(500);
            let elapsed = t.elapsed();
            assert!(elapsed - Duration::from_millis(500) < Duration::from_millis(100));
        }

        #[test]
        fn std_delay() {
            let d = StdDelayNs::default();
            test_delay(d);
        }

        #[test]
        fn tick_delay() {
            let d = TickDelay::<StdTickInstant>::default();
            test_delay(d);
        }
    }
}