Struct PropagatableRateLimits 

pub struct PropagatableRateLimits(/* private fields */);

A wrapper for RateLimits that can only be constructed by RateLimits::propagatable, ensuring that we do not include any dimensioned rate limits in it.

Methods from Deref<Target = RateLimits>

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 is_any_limited(&self, scopings: &[ItemScoping]) -> bool

Returns true if this is instance contains any active rate limits for the specified categories.

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

pub fn is_any_limited_with_quotas<'a>( &self, quotas: impl IntoIterator<Item = &'a Quota>, scopings: &[ItemScoping], ) -> bool

Returns true if this is instance contains any active rate limits for the specified categories.

This is similar to Self::is_limited, 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.

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

pub fn has_expired(&self, now: Instant) -> bool

Returns true if any limit has expired at now.

pub fn propagatable(&self) -> PropagatableRateLimits

Returns only the set of rate limits that can be propagated upstream. At this time, we cannot propagate dimensioned limits, so these must be filtered out.

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 Debug for PropagatableRateLimits

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

Formats the value using the given formatter.

impl Deref for PropagatableRateLimits

type Target = RateLimits

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.