9 unstable releases (3 breaking)
0.4.0 | Mar 10, 2023 |
---|---|
0.3.5 | Jan 28, 2023 |
0.3.4 | Oct 15, 2022 |
0.3.2 | Jul 20, 2022 |
0.1.0 | Jun 12, 2022 |
#568 in Algorithms
36,068 downloads per month
33KB
708 lines
GCRA: A basic implementation
Library which implements the core GCRA functionality in rust.
Features
rate-limiter
a LRU + expiring rate limiter. ImplementsSend + Sync
so can be used asynchronously.
Usage
use gcra::{GcraState, RateLimit};
fn check_rate_limit() {
const LIMIT: u32 = 1;
// Create a rate limit that allows `1/1s`
let rate_limit = RateLimit::per_sec(LIMIT);
let mut user_state = GcraState::default();
assert!(user_state.check_and_modify(&rate_limit, 1).is_ok());
assert!(
user_state.check_and_modify(&rate_limit, 1).is_err(),
"We should be over the limit now"
);
}
With rate-limiter
use gcra::{GcraError, RateLimit, RateLimiter};
#[tokio::main]
async fn main() -> Result<(), GcraError> {
let rate_limit = RateLimit::per_sec(2);
let mut rl = RateLimiter::new(4);
rl.check("key", rate_limit.clone(), 1).await?;
rl.check("key", rate_limit.clone(), 1).await?;
match rl.check("key", rate_limit.clone(), 1).await {
Err(GcraError::DeniedUntil { next_allowed_at }) => {
print!("Denied: Request next at {:?}", next_allowed_at);
Ok(())
}
unexpected => panic!("Opps something went wrong! {:?}", unexpected),
}
}
Dependencies
~0.3–7MB
~22K SLoC