Skip to main content

InMemoryDistributedBackend

Struct InMemoryDistributedBackend 

Source
pub struct InMemoryDistributedBackend { /* private fields */ }
Expand description

In-process distributed rate-limit backend.

Uses a single tokio::sync::Mutex guarding a HashMap so that the entire acquire/refill cycle for any key is one atomic critical section. This makes it correct for concurrent in-process workers and a faithful local stand-in for a Redis backend during tests.

Although it shares one mutex across all keys (simple and contention-safe for tests and single-process deployments), the public contract only promises per-key atomicity, so a future sharded implementation remains compatible.

Implementations§

Source§

impl InMemoryDistributedBackend

Source

pub fn new() -> Self

Create a new empty in-memory backend.

Source

pub async fn key_count(&self) -> usize

Number of keys currently tracked (primarily for tests/diagnostics).

Trait Implementations§

Source§

impl Debug for InMemoryDistributedBackend

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for InMemoryDistributedBackend

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl DistributedRateLimitBackend for InMemoryDistributedBackend

Source§

fn acquire<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, cost: f64, params: RateLimitParams, ) -> Pin<Box<dyn Future<Output = Result<AcquireOutcome>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Atomically attempt to acquire cost permits for key. Read more
Source§

fn available<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, params: RateLimitParams, ) -> Pin<Box<dyn Future<Output = Result<f64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Report the currently available permits for key (after refill). Read more
Source§

fn time_until_available<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, cost: f64, params: RateLimitParams, ) -> Pin<Box<dyn Future<Output = Result<Duration>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Estimate the time until at least cost permits are available for key. Read more
Source§

fn reset<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Clear all stored state for key. Read more
Source§

fn backend_name(&self) -> &str

Backend name, for diagnostics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more