Struct RateLimitResult 

pub struct RateLimitResult {
    pub allowed: bool,
    pub remaining: u32,
    pub reset_at: DateTime<Utc>,
    pub retry_after: Option<Duration>,
}

Result of a rate limit check.

Fields

allowed: bool

Whether the request is allowed.

remaining: u32

Remaining requests in the current window.

reset_at: DateTime<Utc>

When the limit resets.

retry_after: Option<Duration>

Time to wait before retrying (if not allowed).

Implementations

impl RateLimitResult

pub fn allowed(remaining: u32, reset_at: DateTime<Utc>) -> Self

Create a result for an allowed request.

pub fn denied( remaining: u32, reset_at: DateTime<Utc>, retry_after: Duration, ) -> Self

Create a result for a denied request.

pub fn to_error(&self, limit: u32) -> Option<ForgeError>

Convert to a ForgeError if rate limited.

Trait Implementations

impl Clone for RateLimitResult

fn clone(&self) -> RateLimitResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitResult

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

Formats the value using the given formatter.