pub struct TokenBucket<P: Precision, T: TimeSource> { /* private fields */ }Expand description
Token bucket rate limiter with integrated time source and precision handling.
The token bucket algorithm allows bursts up to the bucket capacity while maintaining a sustained average rate through periodic refilling. This implementation integrates the time source directly, eliminating the need for external time management.
§Type Parameters
P- The precision type that determines how Duration values are converted to internal ticksT- The time source type that provides elapsed time since the rate limiter’s reference point
Trait Implementations§
Source§impl<P: Precision, T> Debug for TokenBucket<P, T>where
T: Debug + TimeSource,
impl<P: Precision, T> Debug for TokenBucket<P, T>where
T: Debug + TimeSource,
Source§impl<P: Precision, T: TimeSource> RateLimit for TokenBucket<P, T>
impl<P: Precision, T: TimeSource> RateLimit for TokenBucket<P, T>
Source§fn try_acquire(&self, tokens: Uint) -> SimpleRateLimitResult
fn try_acquire(&self, tokens: Uint) -> SimpleRateLimitResult
Attempts to acquire the specified number of tokens. Read more
Source§fn try_acquire_verbose(&self, tokens: Uint) -> RateLimitResult
fn try_acquire_verbose(&self, tokens: Uint) -> RateLimitResult
Attempts to acquire tokens with detailed diagnostic information. Read more
Source§fn capacity_remaining(&self) -> Result<Uint, SimpleRateLimitError>
fn capacity_remaining(&self) -> Result<Uint, SimpleRateLimitError>
Returns the number of tokens currently available for acquisition. Read more
Auto Trait Implementations§
impl<P, T> !Freeze for TokenBucket<P, T>
impl<P, T> RefUnwindSafe for TokenBucket<P, T>where
T: RefUnwindSafe,
P: RefUnwindSafe,
impl<P, T> Send for TokenBucket<P, T>
impl<P, T> Sync for TokenBucket<P, T>
impl<P, T> Unpin for TokenBucket<P, T>
impl<P, T> UnwindSafe for TokenBucket<P, T>where
T: UnwindSafe,
P: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more