throttle-kit 2.1.0

Rate limiting for Rust — GCRA algorithm with in-memory and Redis backends, Tower layer integration
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

use std::time::Duration;

/// A rate limit quota expressed in the GCRA style.
#[derive(Debug, Clone, Copy)]
pub struct Quota {
    /// Minimum interval between allowed requests.
    interval: Duration,
    /// Maximum burst size.
    pub burst: u32,
}

impl Quota {
    /// Allow `n` requests per second.
    pub fn per_second(n: u32) -> Self {
        Self {
            interval: Duration::from_secs_f64(1.0 / n as f64),
            burst: n,
        }
    }

    /// Allow `n` requests per minute.
    pub fn per_minute(n: u32) -> Self {
        Self {
            interval: Duration::from_secs_f64(60.0 / n as f64),
            burst: n,
        }
    }

    /// Allow `n` requests per hour.
    pub fn per_hour(n: u32) -> Self {
        Self {
            interval: Duration::from_secs_f64(3600.0 / n as f64),
            burst: n,
        }
    }

    /// Override the burst (token bucket) capacity.
    pub fn allow_burst(mut self, burst: u32) -> Self {
        self.burst = burst;
        self
    }

    /// Create a quota with a custom interval and burst size.
    ///
    /// `interval` is the minimum time between allowed requests.
    /// `burst` is the maximum number of requests that can be made in rapid succession.
    pub fn from_parts(interval: Duration, burst: u32) -> Self {
        Self { interval, burst }
    }

    /// The minimum interval between requests.
    pub fn interval(&self) -> Duration {
        self.interval
    }
}