quota 0.3.2

Fastest Lane-parallel Rate-limiter for Rust
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

use num_traits::AsPrimitive;

/// A refill rate normalized to tokens per nanosecond.
///
/// Constructors are named by the time unit callers usually think in. For example,
/// `RefillRate::per_sec(10)` means ten tokens per second.
#[derive(Copy, Clone, Debug)]
pub struct RefillRate(pub(crate) f64);

impl RefillRate {
    /// Returns a refill rate large enough to saturate practical quota capacities immediately.
    #[inline]
    pub fn max() -> Self {
        Self(f64::MAX)
    }

    #[inline]
    /// Creates a rate in tokens per nanosecond.
    pub fn per_nano<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_())
    }
    #[inline]
    /// Creates a rate in tokens per microsecond.
    pub fn per_micro<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 1_000.0)
    }
    #[inline]
    /// Creates a rate in tokens per millisecond.
    pub fn per_milli<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 1_000_000.0)
    }
    #[inline]
    /// Creates a rate in tokens per second.
    pub fn per_sec<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 1_000_000_000.0)
    }

    #[inline]
    /// Creates a rate in tokens per minute.
    pub fn per_minute<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 60_000_000_000.0)
    }

    #[inline]
    /// Creates a rate in tokens per hour.
    pub fn per_hour<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 3600_000_000_000.0)
    }

    #[inline]
    /// Creates a rate in tokens per day.
    pub fn per_day<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 86400_000_000_000.0)
    }

    #[inline]
    /// Creates a rate in tokens per week.
    pub fn per_week<T>(refill_rate_per_second: T) -> Self
    where
        T: AsPrimitive<f64>,
    {
        Self(refill_rate_per_second.as_() / 604800_000_000_000.0)
    }
}