Struct DMSCRateLimiter 

pub struct DMSCRateLimiter { /* private fields */ }

Token bucket based rate limiter implementation.

This struct implements the token bucket algorithm for rate limiting, allowing for both steady-state rate limiting and temporary bursts of requests.

Implementations

impl DMSCRateLimiter

pub fn new(config: DMSCRateLimitConfig) -> Self

Creates a new rate limiter with the specified configuration.

Parameters

• config: The configuration for rate limiting behavior

Returns

A new DMSCRateLimiter instance

pub async fn check_request(&self, request: &DMSCGatewayRequest) -> bool

Checks if a gateway request should be allowed based on rate limiting.

This method uses the client IP address as the key for rate limiting.

Parameters

• request: The gateway request to check

Returns

true if the request should be allowed, false otherwise

pub fn check_rate_limit(&self, key: &str, tokens: usize) -> bool

Checks if a request with a custom key should be allowed based on rate limiting.

This method attempts to consume tokens from the bucket associated with the given key. If no bucket exists for the key, a new one is created.

Parameters

• key: The key to use for rate limiting (e.g., client IP, API key)
• tokens: Number of tokens to consume for this request

Returns

true if the request should be allowed, false otherwise

pub fn get_stats(&self, key: &str) -> Option<DMSCRateLimitStats>

Gets rate limit statistics for a specific key.

Parameters

• key: The key to get statistics for

Returns

An Option<DMSCRateLimitStats> with the statistics, or None if no bucket exists for the key

pub fn get_remaining(&self, key: &str) -> Option<f64>

Gets the remaining tokens for a specific key.

pub fn get_all_stats(&self) -> HashMap<String, DMSCRateLimitStats>

Gets rate limit statistics for all keys.

Returns

A HashMap<String, DMSCRateLimitStats> with statistics for all keys

pub fn reset_bucket(&self, key: &str)

Resets the rate limit bucket for a specific key.

This method removes the bucket for the given key, effectively resetting the rate limit.

Parameters

• key: The key to reset the bucket for

pub fn clear_all_buckets(&self)

Clears all rate limit buckets.

This method removes all buckets, effectively resetting rate limits for all keys.

pub fn get_config(&self) -> DMSCRateLimitConfig

Gets the current rate limit configuration.

Returns

A reference to the current DMSCRateLimitConfig

pub async fn update_config(&mut self, config: DMSCRateLimitConfig)

Updates the rate limit configuration.

This method updates the configuration and resets all buckets with the new settings.

Parameters

• config: The new rate limit configuration

pub async fn check_multi(&self, keys: &[String], tokens: usize) -> Vec<bool>

pub async fn get_keys(&self) -> Vec<String>

pub fn bucket_count(&self) -> usize

Trait Implementations

impl<'py> IntoPyObject<'py> for DMSCRateLimiter

type Target = DMSCRateLimiter

The Python output type

type Output = Bound<'py, <DMSCRateLimiter as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for DMSCRateLimiter

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DMSCRateLimiter

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Token bucket based rate limiter implementation.\n\nThis struct implements the token bucket algorithm for rate limiting, allowing\nfor both steady-state rate limiting and temporary bursts of requests.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<DMSCRateLimiter>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyTypeInfo for DMSCRateLimiter

const NAME: &'static str = "DMSCRateLimiter"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for DMSCRateLimiter

impl ExtractPyClassWithClone for DMSCRateLimiter