Struct RateLimits

pub struct RateLimits { /* private fields */ }

A collection of scoped rate limits.

This collection may be empty, indicated by is_ok. If this instance carries rate limits, they can be iterated over using iter. Additionally, rate limits can be checked for items by invoking check with the respective ItemScoping.

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 into this instance.

This keeps all existing rate limits, adding new ones, and updating ones with a longer retry_after count. The resulting RateLimits contains the merged maximum.

pub fn is_ok(&self) -> bool

Returns true if this instance contains no active limits.

pub fn is_limited(&self) -> bool

Returns true if this instance contains active rate limits.

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

Removes expired rate limits from this instance.

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

Checks whether any rate limits apply to the given scoping.

If no limits match, then the returned RateLimits instance evaluates is_ok. Otherwise, it contains rate limits that match the given scoping.

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

Checks whether any rate limits apply to the given scoping.

This is similar to check. Additionally, it checks for quotas with a static limit 0, and rejects items even if there is no active rate limit in this instance.

If no limits or quotas match, then the returned RateLimits instance evaluates is_ok. Otherwise, it contains rate limits that match the given scoping.

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

Returns an iterator over the rate limits.

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

Returns the longest rate limit.

If multiple rate limits have the same retry after count, any of the limits is returned.

pub fn is_empty(&self) -> bool

Returns true if there are any limits contained.

This is equivalent to checking whether Self::longest returns Some or Self::iter returns an iterator with at least one item.

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.