Struct tower::retry::budget::Budget

source ·
pub struct Budget { /* private fields */ }
Expand description

Represents a “budget” for retrying requests.

This is useful for limiting the amount of retries a service can perform over a period of time, or per a certain number of requests attempted.

Implementations§

source§

impl Budget

source

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

Create a Budget 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 accomodate 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.

source

pub fn deposit(&self)

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

source

pub fn withdraw(&self) -> Result<(), Overdrawn>

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

If there is not enough, an Err(Overdrawn) is returned.

Trait Implementations§

source§

impl Debug for Budget

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Budget

source§

fn default() -> Budget

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.