Struct RateLimits

pub struct RateLimits { /* private fields */ }

A collection of scoped rate limits.

RateLimits manages a set of active rate limits that can be checked against incoming data.

The collection can be empty, indicated by is_ok, meaning no rate limits are currently active.

Implementations

impl RateLimits

pub fn new() -> Self

Creates an empty RateLimits instance.

pub fn add(&mut self, limit: RateLimit)

Adds a limit to this collection.

If a rate limit with an overlapping scope already exists, the retry_after count is merged with the existing limit. Otherwise, the new rate limit is added.

pub fn merge(&mut self, limits: Self)

Merges all limits from another RateLimits instance into this one.

This keeps all existing rate limits, adds new ones, and updates any existing ones with a later expiration time. The resulting collection contains the maximum constraints from both instances.

pub fn is_ok(&self) -> bool

Returns true if this instance contains no active limits.

This is the opposite of is_limited.

pub fn is_limited(&self) -> bool

Returns true if this instance contains any active rate limits.

A rate limit is considered active if it has not yet expired.

pub fn clean_expired(&mut self, now: Instant)

Removes expired rate limits from this instance.

This is useful for cleaning up rate limits that are no longer relevant, reducing memory usage and improving performance of subsequent operations.

pub fn check(&self, scoping: ItemScoping) -> Self

Checks whether any rate limits apply to the given scoping.

Returns a new RateLimits instance containing only the rate limits that match the provided ItemScoping. If no limits match, the returned instance will be empty and is_ok will return true.

pub fn check_with_quotas<'a>( &self, quotas: impl IntoIterator<Item = &'a Quota>, scoping: ItemScoping, ) -> Self

Checks whether any rate limits or static quotas apply to the given scoping.

This is similar to check, but additionally checks for quotas with a static limit of 0, which reject items even if there is no active rate limit in this instance.

Returns a new RateLimits instance containing the rate limits that match the provided ItemScoping. If no limits or quotas match, the returned instance will be empty.

pub fn iter(&self) -> RateLimitsIter<'_>

Returns an iterator over all rate limits in this collection.

pub fn longest(&self) -> Option<&RateLimit>

Returns the rate limit with the latest expiration time.

If multiple rate limits have the same expiration time, any of them may be returned. If the collection is empty, returns None.

pub fn is_empty(&self) -> bool

Returns true if there are no rate limits in this collection.

Note that an empty collection is not the same as having no active limits. Use is_ok to check if there are no active limits.

Trait Implementations

impl Clone for RateLimits

fn clone(&self) -> RateLimits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimits

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

Formats the value using the given formatter.

impl Default for RateLimits

fn default() -> RateLimits

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a RateLimits

type IntoIter = RateLimitsIter<'a>

Which kind of iterator are we turning this into?

type Item = &'a RateLimit

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for RateLimits

type IntoIter = RateLimitsIntoIter

Which kind of iterator are we turning this into?

type Item = RateLimit

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.