flux-limiter 0.8.3

A rate limiter based on the Generic Cell Rate Algorithm (GCRA).
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

// src/lib/lib.rs

//! # Flux Limiter
//!
//! A rate limiter based on the Generic Cell Rate Algorithm (GCRA).
//!
//! ## Quick Example
//!
//! ```rust
//! use flux_limiter::{FluxLimiter, FluxLimiterConfig, SystemClock};
//!
//! let config = FluxLimiterConfig::new(10.0, 5.0);
//! let limiter = FluxLimiter::with_config(config, SystemClock).unwrap();
//!
//! let decision = limiter.check_request("user_123").unwrap();
//! if decision.allowed {
//!     println!("Request allowed");
//! } else {
//!     println!("Rate limited - retry after {:.2}s",
//!              decision.retry_after_seconds.unwrap_or(0.0));
//! }
//! ```

// private modules
mod clock;
mod config;
mod errors;
mod flux_limiter;

// public API exports
pub use clock::{Clock, ClockError, SystemClock};
pub use config::FluxLimiterConfig;
pub use errors::FluxLimiterError;
pub use flux_limiter::{FluxLimiter, FluxLimiterDecision};