tower-rate-tier 0.3.0

Tier-based rate limiting middleware for Tower
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

use std::sync::Arc;
use std::time::Duration;

use tokio::task::JoinHandle;

use crate::clock::Clock;
use crate::storage::memory::MemoryStorage;

/// Handle to the background garbage collection task.
///
/// The GC task is aborted when this handle is dropped.
#[derive(Debug)]
pub struct GcHandle {
    handle: JoinHandle<()>,
}

impl GcHandle {
    /// Spawn a background task that periodically cleans expired entries.
    ///
    /// # Panics
    ///
    /// Panics if `interval` is zero, or if called outside a Tokio runtime.
    pub fn spawn(storage: Arc<MemoryStorage>, clock: Arc<dyn Clock>, interval: Duration) -> Self {
        assert!(!interval.is_zero(), "gc interval must be non-zero");
        let handle = tokio::spawn(async move {
            let mut tick = tokio::time::interval(interval);
            loop {
                tick.tick().await;
                let now = clock.now();
                storage.retain_active(now);
            }
        });
        Self { handle }
    }
}

impl Drop for GcHandle {
    fn drop(&mut self) {
        self.handle.abort();
    }
}