Struct RateLimiter

pub struct RateLimiter { /* private fields */ }

Implementations

impl TokenBucketRateLimiter

pub fn new(rate: usize) -> TokenBucketRateLimiter

Creates a new TokenBucketRateLimiter.

rate specifies the average number of operations allowed per second.

Note: rate MUST be greater than zero.

pub fn burst(&self, burst: usize) -> &TokenBucketRateLimiter

burst specifies the maximum burst number of operations allowed.

The default value of burst is same as rate.

Note: burst MUST be greater than zero.

pub fn try_acquire(&self) -> Result<(), Duration>

Try to acquire a token. Return Ok if the token is successfully acquired, it means that you can safely perform frequency-controlled operations. Otherwise Err(duration) is returned, duration is the minimum time to wait.

pub async fn acquire(&self)

Acquire a token. When the token is successfully acquired, it means that you can safely perform frequency-controlled operations.

pub async fn acquire_with_timeout(&self, timeout: Duration) -> bool

Acquire a token. When the token is successfully acquired, it means that you can safely perform frequency-controlled operations.

If the method fails to obtain a token after exceeding the timeout, false will be returned, otherwise true will be returned.

Trait Implementations

impl Clone for TokenBucketRateLimiter

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.