Struct ItemScoping

pub struct ItemScoping<'a> {
    pub category: DataCategory,
    pub scoping: &'a Scoping,
    pub namespace: MetricNamespaceScoping,
}

Data categorization and scoping information.

ItemScoping is always attached to a Scope and references it internally. It is a cheap, copyable type intended for the use with RateLimits and RateLimiter. It implements Deref<Target = Scoping> and AsRef<Scoping> for ease of use.

Fields

category: DataCategory

The data category of the item.

scoping: &'a 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 of the given scope.

Methods from Deref<Target = Scoping>

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

Returns an ItemScoping for this scope.

The item scoping will contain a reference to this scope and the information passed to this function. This is a cheap operation to allow rate limiting for an individual item.

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

Returns an ItemScoping for metric buckets in this scope.

The item scoping will contain a reference to this scope, the category `MetricBucket, and the information passed to this function. This is a cheap operation to allow rate limiting for an individual item.

Trait Implementations

impl AsRef<Scoping> for ItemScoping<'_>

fn as_ref(&self) -> &Scoping

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ItemScoping<'a>

fn clone(&self) -> ItemScoping<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ItemScoping<'a>

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<'a> Copy for ItemScoping<'a>