Struct UserRateThrottle 

pub struct UserRateThrottle<B = MemoryBackend>
where
    B: ThrottleBackend,
{
    pub rate: usize,
    pub window_secs: u64,
    /* private fields */
}

Available on crate feature rest and non-WebAssembly only.

Rate throttle for authenticated user requests.

Limits the number of requests per time window, keyed by user identifier.

Fields

rate: usize

Maximum number of requests allowed within the time window.

window_secs: u64

Duration of the rate limit window in seconds.

Implementations

impl UserRateThrottle

pub fn new( rate: usize, window_secs: u64, ) -> Result<UserRateThrottle, ThrottleError>

Creates a new UserRateThrottle with a memory backend.

Arguments

• rate - Maximum number of requests allowed (must be non-zero)
• window_secs - Time window in seconds (must be non-zero)

Errors

Returns ThrottleError::InvalidConfig if rate or window_secs is zero.

Examples

use reinhardt_throttling::UserRateThrottle;

// Allow 100 requests per 60 seconds per user
let throttle = UserRateThrottle::new(100, 60).unwrap();
assert_eq!(throttle.rate, 100);
assert_eq!(throttle.window_secs, 60);

impl<B> UserRateThrottle<B>

where B: ThrottleBackend,

pub fn with_backend( rate: usize, window_secs: u64, backend: B, ) -> Result<UserRateThrottle<B>, ThrottleError>

Creates a new UserRateThrottle with a custom backend.

Arguments

• rate - Maximum number of requests allowed (must be non-zero)
• window_secs - Time window in seconds (must be non-zero)
• backend - Custom throttle backend

Errors

Returns ThrottleError::InvalidConfig if rate or window_secs is zero.

Examples

use reinhardt_throttling::{UserRateThrottle, MemoryBackend};

let backend = MemoryBackend::new();
let throttle = UserRateThrottle::with_backend(100, 60, backend).unwrap();
assert_eq!(throttle.rate, 100);
assert_eq!(throttle.window_secs, 60);

Trait Implementations

impl<B> Throttle for UserRateThrottle<B>

where B: ThrottleBackend,

fn allow_request<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, ThrottleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, UserRateThrottle<B>: 'async_trait,

Check whether a request identified by key should be allowed.

fn wait_time<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<u64>, ThrottleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, UserRateThrottle<B>: 'async_trait,

Return the number of seconds the caller should wait before retrying.

fn get_rate(&self) -> (usize, u64)

Return the rate limit configuration as (max_requests, window_seconds).