pub struct KeyedRateLimiter<K: Hash + Eq + Clone + Send + Sync + 'static> { /* private fields */ }Available on crate feature
resilience only.Expand description
Per-key rate limiter for limiting different resources independently.
Useful for per-endpoint, per-user, or per-API-key rate limiting.
Implementations§
Source§impl<K: Hash + Eq + Clone + Send + Sync + 'static> KeyedRateLimiter<K>
impl<K: Hash + Eq + Clone + Send + Sync + 'static> KeyedRateLimiter<K>
Sourcepub fn new(default_rps: u32, default_burst: u32) -> Self
pub fn new(default_rps: u32, default_burst: u32) -> Self
Create a new keyed rate limiter with default limits.
§Arguments
default_rps- Default requests per second for new keysdefault_burst- Default burst capacity for new keys
Sourcepub fn remove_limit(&self, key: &K)
pub fn remove_limit(&self, key: &K)
Remove limit for a key (will use default on next access).
Sourcepub fn check(&self, key: &K) -> Result<(), RateLimitError>
pub fn check(&self, key: &K) -> Result<(), RateLimitError>
Check if a request for a key is allowed.
Sourcepub fn get_status(&self, key: &K) -> Option<RateLimiterStatus>
pub fn get_status(&self, key: &K) -> Option<RateLimiterStatus>
Get status for a specific key.
Sourcepub fn get_all_status(&self) -> Vec<(K, RateLimiterStatus)>
pub fn get_all_status(&self) -> Vec<(K, RateLimiterStatus)>
Get all keys with their status.
Auto Trait Implementations§
impl<K> Freeze for KeyedRateLimiter<K>
impl<K> !RefUnwindSafe for KeyedRateLimiter<K>
impl<K> Send for KeyedRateLimiter<K>
impl<K> Sync for KeyedRateLimiter<K>
impl<K> Unpin for KeyedRateLimiter<K>
impl<K> !UnwindSafe for KeyedRateLimiter<K>
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