SlidingWindowRateLimiter

Struct SlidingWindowRateLimiter 

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

Rate limiter using sliding window algorithm.

§Examples

use chie_shared::SlidingWindowRateLimiter;

// Allow 10 requests per second
let mut limiter = SlidingWindowRateLimiter::new(1000, 10);

// First 10 requests should be allowed
for i in 0..10 {
    assert!(limiter.try_acquire(1000 + i));
}

// 11th request should be denied
assert!(!limiter.try_acquire(1010));

// After window passes, new requests allowed
assert!(limiter.try_acquire(2100));

// Check remaining capacity
let mut limiter2 = SlidingWindowRateLimiter::new(1000, 5);
limiter2.try_acquire(1000);
limiter2.try_acquire(1001);
assert_eq!(limiter2.remaining_capacity(1002), 3);

Implementations§

Source§

impl SlidingWindowRateLimiter

Source

pub fn new(window_ms: u64, max_requests: usize) -> Self

Create a new rate limiter.

§Arguments
  • window_ms - Window size in milliseconds
  • max_requests - Maximum requests allowed in the window
Source

pub fn is_allowed(&mut self, now_ms: i64) -> bool

Check if a request is allowed at the given time.

Source

pub fn try_acquire(&mut self, now_ms: i64) -> bool

Try to consume a token (record a request). Returns true if the request is allowed, false if rate limit is exceeded.

Source

pub fn current_count(&mut self, now_ms: i64) -> usize

Get the current request count in the window.

Source

pub fn remaining_capacity(&mut self, now_ms: i64) -> usize

Get remaining capacity.

Source

pub fn reset(&mut self)

Reset the rate limiter.

Trait Implementations§

Source§

impl Clone for SlidingWindowRateLimiter

Source§

fn clone(&self) -> SlidingWindowRateLimiter

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 SlidingWindowRateLimiter

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, 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.