Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

Token bucket that bounds retries — a client-side retry quota.

Each retry attempt acquires tokens from the bucket; successful requests return or refill tokens. When the bucket is empty, the retry strategy stops retrying and returns the error to the caller, even if max_attempts has not been reached.

A single token bucket is shared by every operation in a RetryPartition. Use TokenBucket::builder to configure its capacity and refill_rate, and attach it to a custom RetryPartition to give a workload its own bucket instead of sharing the default one.

use aws_smithy_runtime::client::retries::TokenBucket;

let token_bucket = TokenBucket::builder()
    .capacity(5000)
    .refill_rate(100.0) // tokens regenerated per second
    .build();

A custom RetryPartition carrying this bucket can then be set on a generated client’s config builder via its retry_partition method.

Implementations

impl TokenBucket

pub fn new(initial_quota: usize) -> TokenBucket

Creates a new TokenBucket with the given initial quota.

pub fn unlimited() -> TokenBucket

A token bucket with unlimited capacity that allows retries at no cost.

pub fn builder() -> TokenBucketBuilder

Creates a builder for constructing a TokenBucket.

pub fn is_full(&self) -> bool

Returns true if the token bucket is full, false otherwise

pub fn is_empty(&self) -> bool

Returns true if the token bucket is empty, false otherwise

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBucket

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

Formats the value using the given formatter.

impl Default for TokenBucket

fn default() -> TokenBucket

Returns the “default value” for a type.

impl Storable for TokenBucket

type Storer = StoreReplace<TokenBucket>

Specify how an item is stored in the config bag, e.g. StoreReplace and StoreAppend