Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Token-bucket rate limiter backed by governor.

Implementations

impl RateLimiter

pub fn new( name: impl Into<String>, per_second: u32, burst: u32, ) -> Result<RateLimiter, AppError>

Create a rate limiter that allows per_second requests/second with a burst capacity of burst.

Errors

Returns an error when per_second or burst is zero.

pub fn from_config(config: RateLimiterConfig) -> Result<RateLimiter, AppError>

Create a rate limiter from a configuration object.

Errors

Returns an error when config.per_second or config.burst is zero.

pub fn check(&self) -> Result<(), AppError>

Non-blocking check: returns Ok(()) if a token was acquired, or Err(AppError::rate_limited()) if the bucket is empty.

Errors

Returns AppError::rate_limited when no token is currently available.

pub async fn until_ready( &self, cancel: Option<CancellationToken>, ) -> Result<(), AppError>

Async wait: blocks until a token is available or cancel fires.

Errors

Returns an error when the cancellation token fires before a token is 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.

impl Debug for RateLimiter

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

Formats the value using the given formatter.