Skip to main content

BoundedKeyedLimiter

Struct BoundedKeyedLimiter 

Source
pub struct BoundedKeyedLimiter<K: Eq + Hash + Clone> { /* private fields */ }
Expand description

Memory-bounded keyed rate limiter.

Cheaply cloneable; clones share state.

Implementations§

Source§

impl<K: Eq + Hash + Clone + Send + Sync + 'static> BoundedKeyedLimiter<K>

Source

pub fn with_per_minute( requests_per_minute: u32, max_tracked_keys: usize, idle_eviction: Duration, ) -> Self

Construct a BoundedKeyedLimiter with a per-minute quota.

Convenience constructor that builds a per-minute Quota from requests_per_minute. The rate is clamped to a minimum of 1 request/min so a misconfigured 0 does not panic at startup.

  • requests_per_minute – per-key rate, clamped to >= 1.
  • max_tracked_keys – hard cap on simultaneously tracked keys. When reached, an insert first prunes idle entries then falls back to LRU eviction.
  • idle_eviction – entries whose last_seen is older than this are eligible for opportunistic pruning.
Source

pub fn with_per_second( requests_per_second: u32, max_tracked_keys: usize, idle_eviction: Duration, ) -> Self

Construct a BoundedKeyedLimiter with a per-second quota.

Convenience constructor that builds a per-second Quota from requests_per_second. The rate is clamped to a minimum of 1 request/sec so a misconfigured 0 does not panic at startup.

  • requests_per_second – per-key rate, clamped to >= 1.
  • max_tracked_keys – hard cap on simultaneously tracked keys. When reached, an insert first prunes idle entries then falls back to LRU eviction.
  • idle_eviction – entries whose last_seen is older than this are eligible for opportunistic pruning.
Source

pub fn check_key(&self, key: &K) -> Result<(), BoundedLimiterError>

Test the per-key quota for key.

Returns Ok(()) if the request is allowed. The last_seen timestamp is updated on every call – including rate-limit rejections – so an actively firing attacker cannot age out into a fresh quota by appearing idle.

When inserting a new key into a full table, idle entries are pruned first; if the table is still full, the entry with the oldest last_seen is evicted (LRU). The new key is always inserted – honest new clients are never rejected because the table is full.

§Errors

Returns BoundedLimiterError::RateLimited when key has exceeded its per-key quota for the current window.

Source

pub fn len(&self) -> usize

Number of currently tracked keys. Used by tests and admin endpoints.

Source

pub fn is_empty(&self) -> bool

true when no keys are currently tracked.

Trait Implementations§

Source§

impl<K: Eq + Hash + Clone> Clone for BoundedKeyedLimiter<K>

Source§

fn clone(&self) -> Self

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

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,