Struct SlidingWindow

pub struct SlidingWindow {
    pub window_seconds: u64,
    pub granularity_seconds: u64,
}

A sliding window.

Fields

window_seconds: u64

The number of seconds to apply the limit to.

granularity_seconds: u64

A number between 1 and window_seconds. Since window_seconds is a sliding window, configure what the granularity of that window is.

If this is equal to window_seconds, the quota resets to 0 every window_seconds. If this is a very small number, the window slides “more smoothly” at the expense of having much more redis keys.

The number of redis keys required to enforce a quota is window_seconds / granularity_seconds.

Implementations

impl SlidingWindow

pub fn iter(&self, timestamp: UnixTimestamp) -> impl Iterator<Item = Slot>

Iterate over the quota’s window, yielding values representing each (absolute) granule.

This function is used to calculate keys for storing the number of requests made in each granule.

The iteration is done in natural-order (oldest timestamp to newest), starting with the key to which a currently-processed request should be added. That request’s timestamp is request_timestamp.

• request_timestamp / self.granularity_seconds
• request_timestamp / self.granularity_seconds + 1
• request_timestamp / self.granularity_seconds + 2
• …

pub fn active_slot(&self, timestamp: UnixTimestamp) -> Slot

The active bucket is the oldest active granule.

Trait Implementations

impl Clone for SlidingWindow

fn clone(&self) -> SlidingWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingWindow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SlidingWindow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SlidingWindow

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SlidingWindow

fn cmp(&self, other: &SlidingWindow) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SlidingWindow

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

fn partial_cmp(&self, other: &SlidingWindow) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SlidingWindow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SlidingWindow

impl Eq for SlidingWindow

impl StructuralPartialEq for SlidingWindow