Struct DefaultRateLimiter 

pub struct DefaultRateLimiter<T> { /* private fields */ }

A token bucket based rate limiter. Cheaply cloneable.

Implementations

impl<T> DefaultRateLimiter<T>

where T: RateLimitAlgorithm,

pub fn new(algorithm: T) -> Self

Create a rate limiter with a given rate limiting algorithm.

pub fn state(&self) -> RateLimiterState

The current state of the rate limiter.

Trait Implementations

impl<T: Clone> Clone for DefaultRateLimiter<T>

fn clone(&self) -> DefaultRateLimiter<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DefaultRateLimiter<T>

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

Formats the value using the given formatter.

impl<T> RateLimiter for DefaultRateLimiter<T>

where T: RateLimitAlgorithm + Sync + Debug,

fn acquire<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Token> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Acquire permission to make a request. Waits until a token is available.

fn acquire_timeout<'life0, 'async_trait>( &'life0 self, duration: Duration, ) -> Pin<Box<dyn Future<Output = Option<Token>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Acquire permission to make a request with a timeout. Returns a token if successful.

fn release<'life0, 'async_trait>( &'life0 self, token: Token, outcome: Option<RequestOutcome>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Release the token and record the outcome of the request. The response time is calculated from when the token was acquired.