Struct Policy 

#[non_exhaustive]
pub struct Policy {
    pub name: String,
    pub limit: u64,
    pub window: Duration,
    pub used: u64,
    pub reset_after: Duration,
}

A policy’s rate-limit state exposed to a downstream handler.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The policy identifier.

limit: u64

The resolved quota limit.

window: Duration

The policy’s window.

used: u64

Used requests in the current window.

reset_after: Duration

Time remaining until the window resets.

Implementations

impl Policy

pub fn remaining(&self) -> u64

Return the remaining quota after the current request.

pub fn is_rate_limited(&self) -> bool

Return true if the policy is rate limited.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Eq for Policy

impl PartialEq for Policy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Policy