Struct RateLimit

pub struct RateLimit {
    pub categories: DataCategories,
    pub scope: RateLimitScope,
    pub reason_code: Option<ReasonCode>,
    pub retry_after: RetryAfter,
    pub namespaces: SmallVec<[MetricNamespace; 1]>,
}

An active rate limit that restricts data ingestion.

A rate limit defines restrictions for specific data categories within a particular scope. It includes an expiration time after which the limit is no longer enforced.

Rate limits can be created from Quotas or directly constructed with the needed parameters.

Fields

categories: DataCategories

A set of data categories that this quota applies to. If empty, this rate limit applies to all data categories.

scope: RateLimitScope

The scope of this rate limit.

reason_code: Option<ReasonCode>

A machine-readable reason indicating which quota caused this rate limit.

retry_after: RetryAfter

A marker when this rate limit expires.

namespaces: SmallVec<[MetricNamespace; 1]>

The metric namespace of this rate limit.

Only relevant for data categories of type metric bucket. If empty, this rate limit applies to metrics of all namespaces.

Implementations

impl RateLimit

pub fn from_quota( quota: &Quota, scoping: Scoping, retry_after: RetryAfter, ) -> Self

Creates a new rate limit from the given Quota.

This builds a rate limit with the appropriate scope derived from the quota and scoping information. The categories and other properties are copied from the quota.

pub fn matches(&self, scoping: ItemScoping) -> bool

Checks whether this rate limit applies to the given item.

A rate limit applies if its scope matches the item’s scope, and the item’s category and namespace match those of the rate limit.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl PartialEq for RateLimit

fn eq(&self, other: &RateLimit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RateLimit