retry_fn 0.2.0

A simple retry function with versions for blocking or non-blocking, tokio or async-std
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

//! constant time backoff
//!
//! Just sets a constant amount of time between each retry
//! ex. |---|---|---|---|
//!
//! ```rust
//! # use retry_fn::strategy::Constant;
//! # use std::time::Duration;
//! let mut s = Constant::new(Duration::from_millis(100));
//! assert_eq!(s.next(), Some(Duration::from_millis(100)));
//! assert_eq!(s.next(), Some(Duration::from_millis(100)));
//! assert_eq!(s.next(), Some(Duration::from_millis(100)));
//! ```
use std::time::Duration;

/// Create a new type representing a constant time iterator
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct Constant {
    duration: Duration,
}

impl From<Duration> for Constant {
    fn from(duration: Duration) -> Self {
        Self { duration }
    }
}

impl Constant {
    /// Create a new `Constant`
    pub fn new(duration: Duration) -> Self {
        duration.into()
    }

    /// create a new type using n milliseconds as the start value
    pub fn from_millis(millis: u64) -> Self {
        Self::new(Duration::from_millis(millis))
    }

    /// create a new type using n seconds as the start value
    pub fn from_secs(secs: u64) -> Self {
        Self::new(Duration::from_secs(secs))
    }

    /// create a new type using n microseconds as the start value
    pub fn from_micros(micros: u64) -> Self {
        Self::new(Duration::from_micros(micros))
    }

    /// create a new type using n nanoseconds as the start value
    pub fn from_nanos(nanos: u64) -> Self {
        Self::new(Duration::from_nanos(nanos))
    }
}

impl Iterator for Constant {
    type Item = Duration;

    fn next(&mut self) -> Option<Self::Item> {
        Some(self.duration)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    #[test]
    fn fixed() {
        let mut s = Constant::new(Duration::from_millis(100));
        assert_eq!(s.next(), Some(Duration::from_millis(100)));
        assert_eq!(s.next(), Some(Duration::from_millis(100)));
        assert_eq!(s.next(), Some(Duration::from_millis(100)));
    }

    #[test]
    fn fixed_secs() {
        let mut s = Constant::new(Duration::from_secs(1));
        assert_eq!(s.next(), Some(Duration::from_secs(1)));
        assert_eq!(s.next(), Some(Duration::from_secs(1)));
        assert_eq!(s.next(), Some(Duration::from_secs(1)));
    }
}