Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Rate limiter implementation.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(5, Duration::from_secs(60));
assert!(limiter.is_allowed("client-1"));

Implementations

impl RateLimiter

pub fn new(max_requests: u32, window: Duration) -> Self

Create a new rate limiter.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(100, Duration::from_secs(60));

pub fn check_rate_limit(&self, key: &str) -> Result<bool>

Check if a request is allowed for the given key.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(2, Duration::from_secs(60));
assert_eq!(limiter.check_rate_limit("k").unwrap(), true);
assert_eq!(limiter.check_rate_limit("k").unwrap(), true);
assert_eq!(limiter.check_rate_limit("k").unwrap(), false);

pub fn is_allowed(&self, key: &str) -> bool

Alias for check_rate_limit for compatibility.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(1, Duration::from_secs(60));
assert!(limiter.is_allowed("k"));
assert!(!limiter.is_allowed("k"));

pub fn remaining_requests(&self, key: &str) -> Result<u32>

Alias for get_remaining_requests for compatibility.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(5, Duration::from_secs(60));
assert_eq!(limiter.remaining_requests("k").unwrap(), 5);

pub fn get_request_count(&self, key: &str) -> Result<usize>

Get the number of requests for a key.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(10, Duration::from_secs(60));
limiter.is_allowed("k");
assert_eq!(limiter.get_request_count("k").unwrap(), 1);

pub fn cleanup(&self) -> Result<usize>

Clean up expired entries.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(10, Duration::from_secs(60));
let removed = limiter.cleanup().unwrap();
assert_eq!(removed, 0);

pub fn reset(&self, key: &str) -> Result<()>

Reset rate limit for a specific key.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(1, Duration::from_secs(60));
limiter.is_allowed("k");
limiter.reset("k").unwrap();
assert!(limiter.is_allowed("k"));

pub fn get_remaining_requests(&self, key: &str) -> Result<u32>

Get remaining requests for a key.

Example

use auth_framework::utils::rate_limit::RateLimiter;
use std::time::Duration;
let limiter = RateLimiter::new(5, Duration::from_secs(60));
limiter.is_allowed("k");
assert_eq!(limiter.get_remaining_requests("k").unwrap(), 4);

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RateLimiter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.