Skip to main content

RateLimiter

Struct RateLimiter 

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

A sliding-window per-key rate limiter.

Each call to RateLimiter::check records a timestamp for the given key and returns true when the number of calls within the current window is still below max_requests. Returns false once the limit is exceeded.

Thread-safe: the internal state is behind a Mutex so it can be shared across threads via global or wrapped in an Arc.

§Example

use rust_web_server::rate_limit::RateLimiter;

let limiter = RateLimiter::new(100, 60); // 100 req / 60 s

if limiter.check("192.168.1.1") {
    // process request
} else {
    // return 429 Too Many Requests
}

Implementations§

Source§

impl RateLimiter

Source

pub fn new(max_requests: u32, window_secs: u64) -> Self

Create a new limiter allowing max_requests per window_secs-second window.

Source

pub fn set_limits(&self, max_requests: u32, window_secs: u64)

Update the limits on a live limiter without restarting.

Changes take effect on the next call to [check] or [remaining]. Called automatically by crate::config_reload::reload on SIGHUP.

Source

pub fn limits(&self) -> (u32, u64)

The current (max_requests, window_secs).

Source

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

Returns true if key (typically a client IP) is within the rate limit, or false if the limit has been exceeded.

A permitted call is always recorded so it counts toward future limits.

Source

pub fn retry_after(&self, _key: &str) -> u64

Seconds a rejected key should wait before trying again.

The window length, a safe upper bound: the oldest request in the window may expire sooner, so a client that waits this long is never rejected again for the same burst — it may only wait longer than strictly needed.

Source

pub fn remaining(&self, key: &str) -> u32

Number of remaining requests key may make within the current window.

Source

pub fn reset(&self, key: &str)

Remove all tracked state for key. Useful in tests.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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