Struct RateLimiter

pub struct RateLimiter {
    pub(crate) inner: ArcSwap<Box<dyn RateLimiterTrait>>,
}

A rate limiter that supports multiple rate limit policy and online policy switch.

Fields

inner: ArcSwap<Box<dyn RateLimiterTrait>>

Implementations

impl RateLimiter

pub(crate) fn new_inner(rate_limit: RateLimit) -> Box<dyn RateLimiterTrait>

pub fn new(rate_limit: RateLimit) -> Self

Create a new rate limiter with given rate limit policy.

pub fn update(&self, rate_limit: RateLimit) -> RateLimit

Update rate limit policy of the rate limiter.

Returns the old rate limit policy.

pub fn monitored(self, table_id: impl Into<TableId>) -> MonitoredRateLimiter

Monitor the rate limiter with related table id.

pub fn rate_limit(&self) -> RateLimit

pub fn check(&self, quota: u64) -> Check

pub async fn wait(&self, quota: u64)

Trait Implementations

impl RateLimiterTrait for RateLimiter

fn rate_limit(&self) -> RateLimit

Return current throttle policy.

fn check(&self, quota: u64) -> Check

Check if the request with the given quota is supposed to be allowed at the moment.

On success, the quota will be consumed. Check::Ok is returned. The caller is supposed to proceed the request with the given quota.

On failure, Check::Retry or Check::RetryAfter is returned. The caller is supposed to retry the check after the given duration or retry after receiving the signal.