pub struct RateLimiter { /* private fields */ }Available on crate feature
resilience only.Expand description
Token bucket rate limiter.
Allows a sustained rate of requests with burst capacity.
Implementations§
Source§impl RateLimiter
impl RateLimiter
Sourcepub fn new(rps: u32, burst_size: u32) -> Self
pub fn new(rps: u32, burst_size: u32) -> Self
Create a new rate limiter.
§Arguments
rps- Maximum requests per secondburst_size- Additional burst capacity above the sustained rate
Sourcepub fn check(&self) -> Result<(), RateLimitError>
pub fn check(&self) -> Result<(), RateLimitError>
Check if a request is allowed without blocking.
Returns Ok(()) if allowed, Err(RateLimitError) if rate limited.
Sourcepub async fn wait(&self)
pub async fn wait(&self)
Wait until a request is allowed.
Blocks the current task until the rate limit permits the request.
Sourcepub fn get_status(&self) -> RateLimiterStatus
pub fn get_status(&self) -> RateLimiterStatus
Get the current status of the rate limiter.
Auto Trait Implementations§
impl !Freeze for RateLimiter
impl !RefUnwindSafe for RateLimiter
impl Send for RateLimiter
impl Sync for RateLimiter
impl Unpin for RateLimiter
impl UnwindSafe for RateLimiter
Blanket Implementations§
§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request