Struct ThrottleResponse

pub struct ThrottleResponse {
    pub allowed: bool,
    pub limit: i64,
    pub remaining: i64,
    pub reset_after: i64,
    pub retry_after: i64,
}

Rate limit response structure

This is the common response format returned by all transports after checking a rate limit.

Response Interpretation

• If allowed is true: The request can proceed
• If allowed is false: The request should be rejected
  • Check retry_after to know when to retry
  • Check reset_after to know when the bucket resets

Example

{
  "allowed": false,
  "limit": 10,
  "remaining": 0,
  "retry_after": 30,
  "reset_after": 60
}

This response indicates the request was denied, no tokens remain, retry in 30 seconds, and the bucket fully resets in 60 seconds.

Fields

allowed: bool

Whether the request is allowed

limit: i64

Maximum burst capacity

remaining: i64

Tokens remaining in the bucket

reset_after: i64

Seconds until the bucket fully resets

retry_after: i64

Seconds until the next request can be made (0 if allowed)

Trait Implementations

impl Clone for ThrottleResponse

fn clone(&self) -> ThrottleResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThrottleResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThrottleResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(bool, RateLimitResult)> for ThrottleResponse

fn from((allowed, result): (bool, RateLimitResult)) -> Self

Converts to this type from the input type.

impl Serialize for ThrottleResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.