Struct ThrottlesService

pub struct ThrottlesService { /* private fields */ }

A service for throttling attempts from an IP address.

Tracks the number of attempts (hits) from a given IP address and determines whether further attempts should be allowed based on configured limits.

Examples

use std::time::Duration;
use cache_ro::Cache;
use throttle_ro::ThrottlesService;

let cache = Cache::new(Default::default()); // In real usage, configure properly
let ip = "127.0.0.1".to_string();
let mut service = ThrottlesService::new(
    ip,
    5, // max attempts
    Duration::from_secs(60), // time window
    "rate_limit_"
);

if service.can_go(&cache) {
    service.hit(&cache);
    // Process the request
} else {
    // Reject the request - rate limit exceeded
}

Implementations

impl ThrottlesService

pub fn new( ip: String, max_attempts: u32, period: Duration, prefix: &str, ) -> Self

Creates a new ThrottlesService instance.

Arguments

• ip - The IP address to track
• max_attempts - Maximum number of allowed attempts in the time period
• period - Duration of the throttling window
• prefix - Prefix for cache keys to avoid collisions

pub fn can_go(&mut self, cache: &Cache) -> bool

Checks whether the IP is allowed to make another attempt.

Returns true if the current attempt count is below the maximum allowed.

pub fn key(&self) -> String

Generates the cache key for this IP.

pub fn get_expire(&mut self, cache: &Cache) -> Duration

Gets the remaining duration for the current throttling window.

Returns the configured period if no expiration is set in the cache.

pub fn hit(&mut self, cache: &Cache)

Records an attempt (hit) from the IP.

Increments the attempt count and resets the expiration time.

pub fn remove(&self, cache: &Cache)

Clears the attempt count for the IP.