Struct ItemScoping

pub struct ItemScoping {
    pub category: DataCategory,
    pub scoping: Scoping,
    pub namespace: MetricNamespaceScoping,
}

Data categorization and scoping information for a single item.

ItemScoping combines a data category, scoping information, and optional metric namespace to fully define an item for rate limiting purposes.

Fields

category: DataCategory

The data category of the item.

scoping: Scoping

Scoping of the data.

namespace: MetricNamespaceScoping

Namespace for metric items, requiring DataCategory::MetricBucket.

Implementations

impl ItemScoping

pub fn scope_id(&self, scope: QuotaScope) -> Option<u64>

Returns the identifier for the given quota scope.

Maps the quota scope type to the corresponding identifier from this scoping, or None if the scope type doesn’t have an applicable identifier.

Methods from Deref<Target = Scoping>

pub fn item(&self, category: DataCategory) -> ItemScoping

Creates an ItemScoping for a specific data category in this scope.

The returned item scoping contains a reference to this scope and the provided data category. This is a cheap operation that allows for efficient rate limiting of individual items.

pub fn metric_bucket(&self, namespace: MetricNamespace) -> ItemScoping

Creates an ItemScoping specifically for metric buckets in this scope.

The returned item scoping contains a reference to this scope, the DataCategory::MetricBucket category, and the provided metric namespace. This is specialized for handling metrics with namespaces.

Trait Implementations

impl Clone for ItemScoping

fn clone(&self) -> ItemScoping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemScoping

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

Formats the value using the given formatter.

impl Deref for ItemScoping

type Target = Scoping

The resulting type after dereferencing.

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

Dereferences the value.

impl PartialEq for ItemScoping

fn eq(&self, other: &ItemScoping) -> 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 Copy for ItemScoping

impl Eq for ItemScoping

impl StructuralPartialEq for ItemScoping