Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

👎Deprecated since 3.1.0: This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Enforces a rate limit on the volume of requests per unit time.

Instances update the amount of tokens upon access, and thus does not need to be constantly polled to refill. Uses atomics internally so should be relatively cheap to access from many threads

Implementations

impl TokenBucket

pub fn new( initial_tokens: u64, max_tokens: u64, new_tokens_per_second: f64, ) -> Self

👎Deprecated since 3.1.0: This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Allocate a new TokenBucket

pub fn current_tokens(&self) -> u64

👎Deprecated since 3.1.0: This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Return current amount of tokens in the bucket. This may be somewhat inconsistent across threads due to Relaxed atomics.

pub fn consume_tokens(&self, request_size: u64) -> Result<u64, u64>

👎Deprecated since 3.1.0: This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Attempts to consume tokens from bucket.

On success, returns Ok(amount of tokens left in the bucket). On failure, returns Err(amount of tokens missing to fill request).

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> Self

Clones the TokenBucket with approximate state of the original. While this will never return an object in an invalid state, using this in a contended environment is not recommended.

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

Performs copy-assignment from source.