Struct simple_rate_limit::RateLimiter

pub struct RateLimiter {
    pub limit: RateLimit,
    // some fields omitted
}

A RateLimiter enforces a RateLimit by maintaining a ring vector of timestamps capped at the RateLimit::count.

Fields

limit: RateLimit

Implementations

impl RateLimiter

pub fn new(limit: RateLimit) -> RateLimiter

Creates a new RateLimiter without preallocating storage. Ideal if you might never use it.

pub fn new_preallocated(limit: RateLimit) -> RateLimiter

Creates a new RateLimiter with preallocated storage. Ideal if you're likely to use it a lot to avoid resizing during fill.

pub fn check(&mut self) -> bool

Logs the current time with the RateLimiter and checks if the event falls within the rate limit.

pub fn check_at(&mut self, instant: Instant) -> bool

Like check, but you can provide an arbitrary timestamp (useful for tests!). Promise that you'll only march forwards in time and we promise to return the correct answers.

pub fn sweep(&mut self, instant: Instant) -> bool

Removes all the readings from longer than the contained RateLimit's period ago, relative to the provided instant.