Struct ThrottleResult

pub struct ThrottleResult {
    pub throttled: bool,
    pub limit: u64,
    pub remaining: u64,
    pub reset_after: Duration,
    pub retry_after: Option<Duration>,
}

Fields

throttled: bool

true if the action was limited

limit: u64

The total limit of the key (max_burst + 1). This is equivalent to the common X-RateLimit-Limit HTTP header.

remaining: u64

The remaining limit of the key. Equivalent to X-RateLimit-Remaining.

reset_after: Duration

The number of seconds until the limit will reset to its maximum capacity. Equivalent to X-RateLimit-Reset.

retry_after: Option<Duration>

The number of seconds until the user should retry, but None if the action was allowed. Equivalent to Retry-After.

Trait Implementations

impl Debug for ThrottleResult

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

Formats the value using the given formatter.

impl PartialEq for ThrottleResult

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ThrottleResult

impl StructuralPartialEq for ThrottleResult