Struct TpsBudget

pub struct TpsBudget { /* private fields */ }

A Transactions Per Minute config for managing retry tokens.

TpsBudget uses a token bucket to decide if the request should be retried.

TpsBudget works by checking how much retries have been made in a certain period of time. Minimum allowed number of retries are effectively reset on an interval. Allowed number of retries depends on failed request count in recent time frame.

For more info about Budget, please see the module-level documentation.

Implementations

impl TpsBudget

pub fn new(ttl: Duration, min_per_sec: u32, retry_percent: f32) -> Self

Create a TpsBudget that allows for a certain percent of the total requests to be retried.

• The ttl is the duration of how long a single deposit should be considered. Must be between 1 and 60 seconds.

• The min_per_sec is the minimum rate of retries allowed to accommodate clients that have just started issuing requests, or clients that do not issue many requests per window.

• The retry_percent is the percentage of calls to deposit that can be retried. This is in addition to any retries allowed for via min_per_sec. Must be between 0 and 1000.

  As an example, if 0.1 is used, then for every 10 calls to deposit, 1 retry will be allowed. If 2.0 is used, then every deposit allows for 2 retries.

Trait Implementations

impl Budget for TpsBudget

fn deposit(&self)

Store a “deposit” in the budget, which will be used to permit future withdrawals.

fn withdraw(&self) -> bool

Check whether there is enough “balance” in the budget to issue a new retry.

impl Debug for TpsBudget

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

Formats the value using the given formatter.

impl Default for TpsBudget

fn default() -> Self

Returns the “default value” for a type.