Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

A token-bucket rate limiter.

Limits the rate of operations to rate per interval. When the rate is exceeded, further requests are denied until the next window.

Implementations

impl RateLimiter

pub fn new_rate(rate: u64) -> Self

Create a new rate limiter allowing rate operations per second.

pub fn new_rate_interval(rate: u64, interval: Duration) -> Self

Create a new rate limiter with a custom rate and interval.

pub async fn check(&self) -> bool

Check whether an operation is allowed right now.

Returns true if within the rate limit, false if the bucket is exhausted.

pub async fn time_until_available(&self) -> Duration

Returns the duration until the next token becomes available.

Returns Duration::ZERO if tokens are immediately available, Duration::MAX if the rate is zero.

pub async fn wait(&self)

Block until a token is available, then consume it.

Sleeps for the remaining window duration when the bucket is exhausted, then retries. Returns immediately if tokens are available.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.