Struct relay_quotas::CachedRateLimits

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

Like RateLimits, a collection of scoped rate limits but with all the checks necessary to cache the limits.

The data structure makes sure no expired rate limits are enforced as well as removing any indexed rate limit.

Cached rate limits don’t enforce indexed rate limits because at the time of the check the decision whether an envelope is sampled or not is not yet known. Additionally even if the item is later dropped by dynamic sampling, it must still be around to extract metrics and cannot be dropped too early.

Implementations

impl CachedRateLimits

pub fn new() -> Self

Creates a new, empty instance without any rate limits enforced.

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

Adds a limit to this collection.

See also: RateLimits::add.

pub fn merge(&mut self, rate_limits: RateLimits)

Merges more rate limits into this instance.

See also: RateLimits::merge.

pub fn current_limits(&mut self) -> &RateLimits

Returns a reference to the contained rate limits.

This call gurantuess that at the time of call no returned rate limit is expired.

Trait Implementations

impl Debug for CachedRateLimits

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

Formats the value using the given formatter.

impl Default for CachedRateLimits

fn default() -> CachedRateLimits

Returns the “default value” for a type.