Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Token-bucket rate limiter. Cheap to clone; the inner state is Arc<Mutex<_>>.

Implementations

impl RateLimiter

pub fn new(rate_per_second: f64, burst: u32) -> Self

Build a limiter that produces rate_per_second tokens, capped at burst.

Panics

Panics if rate_per_second is not positive or burst is zero.

pub async fn acquire(&self)

Wait until a token is available, then consume it.

pub async fn acquire_n(&self, n: u32)

Wait until n tokens are available, then consume them.

Panics

Panics if n exceeds the configured burst (it could never be granted).

pub async fn try_acquire(&self) -> bool

Try to consume one token without waiting. Returns true on success.

pub async fn try_acquire_n(&self, n: u32) -> bool

Try to consume n tokens without waiting. Returns true on success.

pub async fn tokens(&self) -> f64

Current bucket level (mostly useful for tests + telemetry).

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.

impl Debug for RateLimiter

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

Formats the value using the given formatter.