Struct KeyedRateLimiter

pub struct KeyedRateLimiter<K>
where
    K: Ord,
{ /* private fields */ }

A rate limiter that utilizes a BTreeMap to map K -> SlidingWindowRateLimiter, allowing for a per-argument rate limiter.

This is used for several endpoints that are rate limited by IP and trading pair, so each pair is given a unique rate limiter.

Implementations

impl<K> KeyedRateLimiter<K>

where K: Ord,

pub fn new() -> Self

Create an empty instance with no rate limiters.

pub fn add_rate_limiter( &mut self, key: K, rate_limiter: SlidingWindowRateLimiter, ) -> Option<SlidingWindowRateLimiter>

Add a rate limiter implementation for a given key, such that self.wait_until_ready(key) will use this rate limiter.

This can overwrite previous rate limiters if the key already exists and returns/follows the same semantics as BTreeMap’s insert method.

pub fn remove_rate_limiter( &mut self, key: &K, ) -> Option<SlidingWindowRateLimiter>

Remove a rate limiter from the internal map. This may result in subsequent usages of this key using a default rate limiter.

This follows the same return semantics as BTreeMap’s remove method.

pub async fn wait_until_ready(&mut self, key: K)

Follows the same semantics as SlidingWindowRateLimiter, except it looks up a rate limiter by key, and creates a rate limiter if none is found.

pub async fn wait_with_cost(&mut self, cost: usize, key: K)

Follows the same semantics as SlidingWindowRateLimiter, except it looks up a rate limiter by key, and creates a rate limiter if none is found.

Trait Implementations

impl<K> Clone for KeyedRateLimiter<K>

where K: Ord + Clone,

fn clone(&self) -> KeyedRateLimiter<K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K> Debug for KeyedRateLimiter<K>

where K: Ord + Debug,

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

Formats the value using the given formatter.

impl<K> Default for KeyedRateLimiter<K>

where K: Ord,

fn default() -> Self

Returns the “default value” for a type.