RateLimiter

Struct RateLimiter 

Source
pub struct RateLimiter { /* private fields */ }
Expand description

A configurable rate limiter for controlling request rates.

This rate limiter supports multiple strategies:

  • Token bucket: Continuous token replenishment with burst capacity
  • Fixed window: Fixed request count per time window
  • Custom strategies via the RateLimitStrategy trait

§Example

use riglr_core::util::{RateLimiter, RateLimitStrategyType};
use std::time::Duration;

// Default token bucket strategy
let rate_limiter = RateLimiter::new(10, Duration::from_secs(60));

// Check rate limit for a user
rate_limiter.check_rate_limit("user123")?;

// Use fixed window strategy
let fixed_limiter = RateLimiter::builder()
    .strategy(RateLimitStrategyType::FixedWindow)
    .max_requests(100)
    .time_window(Duration::from_secs(60))
    .build();

Implementations§

Source§

impl RateLimiter

Source

pub fn new(max_requests: usize, time_window: Duration) -> Self

Create a new rate limiter with the default token bucket strategy

Source

pub fn with_strategy<S: RateLimitStrategy + 'static>(strategy: S) -> Self

Create a rate limiter with a custom strategy

Source

pub fn builder() -> RateLimiterBuilder

Create a new rate limiter builder for advanced configuration

Source

pub fn check_rate_limit(&self, client_id: &str) -> Result<(), ToolError>

Check if a client has exceeded the rate limit

§Arguments
  • client_id - Unique identifier for the client (e.g., IP address, user ID)
§Returns
  • Ok(()) if the request is allowed
  • Err(ToolError::RateLimited) if the rate limit is exceeded
Source

pub fn reset_client(&self, client_id: &str)

Reset rate limit for a specific client

Source

pub fn clear_all(&self)

Clear all rate limit data

Source

pub fn get_request_count(&self, client_id: &str) -> usize

Get current request count for a client

Source

pub fn strategy_name(&self) -> &str

Get the name of the current strategy

Trait Implementations§

Source§

impl Clone for RateLimiter

Source§

fn clone(&self) -> RateLimiter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimiter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,