Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Window quotas for one API surface: a general bucket every request passes, then the buckets of the first row its method and path match.

Built by WindowQuotaTable; a venue’s crate builds one for each of its API surfaces. A clone shares the buckets and the Hold.

Implementations

impl RateLimiter

pub fn begin_cooldown(&self, delay: Duration)

Hold every request on this limiter for delay: Hold::extend on its hold, which extends a hold in force but never shortens one.

The send loop holds through Throttle::hold, which calls this, when its policy decides a response holds the client. Reach for this directly only when driving the limiter from a transport this crate does not own.

pub fn hold(&self) -> &Hold

The hold every request on this limiter waits out, to share with another layer.

pub async fn acquire(&self, path: &str, method: Option<&Method>)

Await the appropriate limiter(s) for this endpoint.

Waits out any hold a previous 429 imposed, then awaits the default (general) limiter, then additionally awaits the first matching endpoint-specific limiter (burst + sustained), then waits out the hold again, in case it moved while this call waited on a bucket. Every wait sleeps on the hold’s runtime.

pub fn effective_quota( &self, method: &Method, path: &str, ) -> Vec<EffectiveQuota>

The quotas a request is held to, in the order acquire awaits them: the general bucket first, then the buckets of the first row method and path match.

pub fn rows(&self) -> Vec<QuotaRow<'_>>

Every row, in the order requests are matched against them.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> Self

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.

impl Throttle for RateLimiter

Counts requests: each attempt is charged one request against the general bucket and its row’s buckets, found from the method and path, and hold extends the limiter’s Hold.

fn observe( &self, _charge: &Charge, _response: &ResponseMeta<'_>, _attempt: &AttemptInfo, )

Nothing to record: the buckets model the published quota, not what a response says.

async fn acquire(&self, meta: &RequestMeta<'_>) -> Result<Charge, Refused>

Wait until the request may be sent, and charge it.

fn hold(&self, delay: Duration)

Hold every request on this throttle for delay. A hold only ever extends.