pub struct TokenBucket { /* private fields */ }Expand description
A token bucket: accumulates capacity tokens at refill_rate tokens/second.
Starts full (all tokens available). Each API call consumes one or more tokens.
Tokens are replenished continuously up to capacity.
Implementations§
Source§impl TokenBucket
impl TokenBucket
Sourcepub fn new(capacity: f64, refill_rate: f64) -> Self
pub fn new(capacity: f64, refill_rate: f64) -> Self
Create a new token bucket with the given capacity and refill rate.
§Arguments
capacity— maximum number of tokens (burst ceiling)refill_rate— tokens added per second (sustained throughput)
Sourcepub fn try_consume(&mut self, tokens: f64) -> bool
pub fn try_consume(&mut self, tokens: f64) -> bool
Try to consume tokens from the bucket.
Returns true if the tokens were available and consumed,
false if the bucket is too empty (caller should wait).
Sourcepub fn wait_time(&mut self, tokens: f64) -> Duration
pub fn wait_time(&mut self, tokens: f64) -> Duration
Estimate wait time before tokens become available.
Returns Duration::ZERO if sufficient tokens exist right now.
Sourcepub fn available_tokens(&mut self) -> f64
pub fn available_tokens(&mut self) -> f64
Return the current token count after applying any accumulated refill
Sourcepub fn refill_rate(&self) -> f64
pub fn refill_rate(&self) -> f64
Return the configured refill rate in tokens per second
Trait Implementations§
Auto Trait Implementations§
impl Freeze for TokenBucket
impl RefUnwindSafe for TokenBucket
impl Send for TokenBucket
impl Sync for TokenBucket
impl Unpin for TokenBucket
impl UnsafeUnpin for TokenBucket
impl UnwindSafe for TokenBucket
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.