Struct RedisQuota

pub struct RedisQuota<'a> { /* private fields */ }

Reference to information required for tracking quotas in Redis.

Implementations

impl<'a> RedisQuota<'a>

pub fn new( quota: &'a Quota, scoping: ItemScoping, timestamp: UnixTimestamp, ) -> Option<Self>

Creates a new RedisQuota from a Quota, item scoping, and timestamp.

Returns None if the quota cannot be tracked in Redis because it’s missing required fields (ID or window). This allows forward compatibility with future quota types.

pub fn build_owned(&self) -> OwnedRedisQuota

Converts this RedisQuota to an OwnedRedisQuota leaving the original struct in place.

pub fn window(&self) -> u64

Returns the window size of the quota in seconds.

pub fn prefix(&self) -> &'a str

Returns the prefix of the quota used for Redis key generation.

pub fn limit(&self) -> i64

Returns the limit value formatted for Redis.

Returns -1 for unlimited quotas or when the limit doesn’t fit into an i64. Otherwise, returns the limit value as an i64.

pub fn slot(&self) -> u64

Returns the current time slot of the quota based on the timestamp.

Slots are used to determine the time bucket for rate limiting.

pub fn expiry(&self) -> UnixTimestamp

Returns the timestamp when the current quota window will expire.

pub fn key_expiry(&self) -> u64

Returns when the Redis key should expire.

This is the expiry time plus a grace period.

pub fn key(&self) -> String

Returns the Redis key for this quota.

The key includes the quota ID, organization ID, and other scoping information based on the quota’s scope type. Keys are structured to ensure proper isolation between different organizations and scopes.

Methods from Deref<Target = Quota>

pub fn is_valid(&self) -> bool

Returns whether this quota is valid for tracking.

A quota is considered invalid if any of the following conditions are true:

• The quota only applies to DataCategory::Unknown data categories.
• The quota is counted (not limit 0) but specifies categories with different units.
• The quota references an unsupported namespace.

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

Checks whether the quota’s constraints match the current item.

This method determines if this quota should be applied to a given item based on its scope, categories, and namespace.

Trait Implementations

impl<'a> Clone for RedisQuota<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RedisQuota<'a>

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

Formats the value using the given formatter.

impl Deref for RedisQuota<'_>

type Target = Quota

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> PartialEq for RedisQuota<'a>

fn eq(&self, other: &RedisQuota<'a>) -> 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<'a> Eq for RedisQuota<'a>

impl<'a> StructuralPartialEq for RedisQuota<'a>