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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
use std::sync::Arc;
use std::time::{Duration, Instant};

use parking_lot::Mutex;

/** RateLimit is a simple token bucket-style rate limiter

When its tokens are exhausted, it will block the current thread until its refilled

The limiter is cheaply-clonable
```no_run
# fn main() {
use std::time::Duration;
use ratelimit::RateLimit;

// limits to 3 `.take()` per 1 second
let mut limiter = RateLimit::full(3, Duration::from_secs(1));
for _ in 0..10 {
    // every 3 calls within 1 second will cause the next .take() to block
    // so this will take ~3 seconds to run (10 / 3 = ~3)
    limiter.take();
}

// initially empty, it will block for 1 second then block for every 3 calls per 1 second
let mut limiter = RateLimit::empty(3, Duration::from_secs(1));
for _ in 0..10 {
    limiter.take();
}
# }
```

The `_unsync()` variants create a cheaper, single-threaded variant
**/
pub struct RateLimit {
    cap: u64,
    bucket: Bucket,
}

impl RateLimit {
    /// Create a new, thread-safe limiter
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `initial` is how many are initially available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    pub fn new(cap: u64, initial: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::sync(cap, initial, period),
        }
    }

    /// Create a new, single-threaded limiter
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `initial` is how many are initially available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    pub fn new_unsync(cap: u64, initial: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::unsync(cap, initial, period),
        }
    }

    /// Create a thread-safe limiter thats pre-filled
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    #[inline]
    pub fn full(cap: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::sync(cap, cap, period),
        }
    }

    /// Create an empty thread-safe limiter
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    #[inline]
    pub fn empty(cap: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::sync(cap, 0, period),
        }
    }

    /// Returns the capacity of this RateLimit
    pub fn cap(&self) -> u64 {
        self.cap
    }

    /// Create a single-threaded limiter thats pre-filled
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    #[inline]
    pub fn full_unsync(cap: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::unsync(cap, cap, period),
        }
    }

    /// Create an empty single-threaded limiter
    ///
    /// `cap` is the number of total tokens available
    ///
    /// `period` is how long it'll take to refill all of the tokens
    #[inline]
    pub fn empty_unsync(cap: u64, period: Duration) -> Self {
        Self {
            cap,
            bucket: Bucket::unsync(cap, 0, period),
        }
    }

    /// Tries to consume `tokens`
    ///
    /// If it will consume more than available then an Error is returned.
    /// Otherwise it returns how many tokens are left
    ///
    /// This error is the `Duration` of the next available time
    pub fn consume(&mut self, tokens: u64) -> Result<u64, Duration> {
        let now = Instant::now();

        // no specialization yet and I don't want to have the consumers pass in
        // the {Sync|Unsync}Bucket, so simply just use a macro here
        macro_rules! consume {
            ($inner:expr) => {{
                if let Some(n) = $inner.refill(now) {
                    $inner.tokens = std::cmp::min($inner.tokens + n, self.cap);
                };

                if tokens <= $inner.tokens {
                    $inner.tokens -= tokens;
                    $inner.backoff = 0;
                    return Ok($inner.tokens);
                }

                let prev = $inner.tokens;
                Err($inner.estimate(tokens - prev, now))
            }};
        }

        match self.bucket {
            Bucket::Sync(ref sync) => {
                let mut sync = sync.lock();
                consume!(sync)
            }
            Bucket::Unsync(ref mut unsync) => {
                let mut unsync = unsync;
                consume!(unsync)
            }
        }
    }

    /// Consumes `tokens` blocking if its trying to consume more than available
    ///
    /// Returns how many tokens are available
    pub fn throttle(&mut self, tokens: u64) -> u64 {
        loop {
            match self.consume(tokens) {
                Ok(rem) => return rem,
                Err(time) => std::thread::sleep(time),
            }
        }
    }

    /// Take a token, blocking if unavailable
    ///
    /// Returns how many tokens are available
    #[inline]
    pub fn take(&mut self) -> u64 {
        self.throttle(1)
    }
}

enum Bucket {
    Sync(Arc<Mutex<Inner>>),
    Unsync(Inner),
}

impl Bucket {
    fn sync(cap: u64, initial: u64, period: Duration) -> Self {
        Bucket::Sync(Arc::new(Mutex::new(Inner::new(cap, initial, period))))
    }
    fn unsync(cap: u64, initial: u64, period: Duration) -> Self {
        Bucket::Unsync(Inner::new(cap, initial, period))
    }
}

#[derive(Clone)]
struct Inner {
    tokens: u64,
    backoff: u32,

    next: Instant,
    last: Instant,

    quantum: u64,
    period: Duration,
}

impl Inner {
    fn new(tokens: u64, initial: u64, period: Duration) -> Self {
        let now = Instant::now();
        Self {
            tokens: initial,
            backoff: 0,

            next: now + period,
            last: now,

            quantum: tokens,
            period,
        }
    }

    fn refill(&mut self, now: Instant) -> Option<u64> {
        if now < self.next {
            return None;
        }
        let last = now.duration_since(self.last);
        let periods = last.as_nanos().checked_div(self.period.as_nanos())? as u64;
        self.last += self.period * (periods as u32);
        self.next = self.last + self.period;
        Some(periods * self.quantum)
    }

    fn estimate(&mut self, tokens: u64, now: Instant) -> Duration {
        let until = self.next.duration_since(now);
        let periods = (tokens.checked_add(self.quantum).unwrap() - 1) / self.quantum;
        until + self.period * (periods as u32 - 1)
    }
}