timer-kit 0.1.1

A timer toolkit that is generic over the underlying timer implementation.
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
130
131
132
133
134
135
136
137
138
139
140
141

#![allow(dead_code, unused_imports)]

use std::time::Duration;

use timer_kit::{Delay, Instant};

use super::*;

pub async fn interval_zero_duration<D>() 
where
    D: Delay,
    D::Instant: Unpin,
{
    let _ = timer_kit::interval::<D>(Duration::from_millis(0));
}

pub async fn burst<D>() 
where
    D: Delay,
    D::Instant: Unpin,
{
    let start = D::Instant::now() + Duration::from_millis(100);
    let mut interval = timer_kit::interval_at::<D>(start, Duration::from_millis(300));
    interval.set_missed_tick_behavior(timer_kit::MissedTickBehavior::Burst);

    // Give a 1ms buffer
    timer_kit::sleep::<D>(Duration::from_millis(1)).await;
    assert_interval_poll_pending!(interval);

    // Interval starts at 100ms
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_ready!(interval);

    // Miss two tick
    timer_kit::sleep::<D>(Duration::from_millis(700)).await;
    assert_interval_poll_ready!(interval);
    timer_kit::sleep::<D>(Duration::from_millis(10)).await;
    assert_interval_poll_ready!(interval);
    assert_interval_poll_pending!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(200)).await;
    assert_interval_poll_ready!(interval);
    assert_interval_poll_pending!(interval);
}

pub async fn delay<D>() 
where
    D: Delay,
    D::Instant: Unpin,
{
    let start = D::Instant::now() + Duration::from_millis(100);
    let mut interval = timer_kit::interval_at::<D>(start, Duration::from_millis(300));
    interval.set_missed_tick_behavior(timer_kit::MissedTickBehavior::Delay);

    // Give a 1ms buffer
    timer_kit::sleep::<D>(Duration::from_millis(1)).await;
    assert_interval_poll_pending!(interval);

    // Interval starts at 100ms
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_ready!(interval);

    // Miss two tick
    timer_kit::sleep::<D>(Duration::from_millis(700)).await;
    assert_interval_poll_ready!(interval);
    assert_interval_poll_pending!(interval);

    // Next tick is delayed until 1100ms
    timer_kit::sleep::<D>(Duration::from_millis(200)).await;
    assert_interval_poll_pending!(interval);
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_ready!(interval);

    // Next tick is delayed until 1400ms
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_pending!(interval);
    timer_kit::sleep::<D>(Duration::from_millis(200)).await;
    assert_interval_poll_ready!(interval);
}

pub async fn skip<D>() 
where
    D: Delay,
    D::Instant: Unpin,
{
    let start = D::Instant::now() + Duration::from_millis(100);
    let mut interval = timer_kit::interval_at::<D>(start, Duration::from_millis(300));
    interval.set_missed_tick_behavior(timer_kit::MissedTickBehavior::Skip);

    // Give a 1ms buffer
    timer_kit::sleep::<D>(Duration::from_millis(1)).await;
    assert_interval_poll_pending!(interval);

    // Interval starts at 100ms
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_ready!(interval);

    // Miss two tick
    timer_kit::sleep::<D>(Duration::from_millis(700)).await;
    assert_interval_poll_ready!(interval);
    assert_interval_poll_pending!(interval);
    
    timer_kit::sleep::<D>(Duration::from_millis(200)).await;
    assert_interval_poll_ready!(interval);
    assert_interval_poll_pending!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(300)).await;
    assert_interval_poll_ready!(interval);
}

pub async fn reset<D>() 
where
    D: Delay,
    D::Instant: Unpin,
{
    let start = D::Instant::now() + Duration::from_millis(100);
    let mut interval = timer_kit::interval_at::<D>(start, Duration::from_millis(300));

    // Give a 1ms buffer
    timer_kit::sleep::<D>(Duration::from_millis(1)).await;
    assert_interval_poll_pending!(interval);

    // Interval starts at 100ms
    timer_kit::sleep::<D>(Duration::from_millis(100)).await;
    assert_interval_poll_ready!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(300)).await;
    assert_interval_poll_ready!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(50)).await;
    interval.reset();

    timer_kit::sleep::<D>(Duration::from_millis(250)).await;
    assert_interval_poll_pending!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(50)).await;
    assert_interval_poll_ready!(interval);

    timer_kit::sleep::<D>(Duration::from_millis(300)).await;
    assert_interval_poll_ready!(interval);
}