Struct Limit

pub struct Limit<const COUNT: usize, const PER: u64, K>(pub K::Extractor)
where
    K: Key;

Represents a rate limit configuration with generic parameters for count and time period. This struct uses generics to allow flexible integration with any extractor that implements the Key trait.

Tuple Fields

0: K::Extractor

Implementations

impl<const COUNT: usize, const PER: u64, K> Limit<COUNT, PER, K>

where K: Key,

pub const fn count() -> usize

Returns the count of requests allowed within the specified period.

pub const fn per() -> u64

Returns the period (in milliseconds) for which the limit applies.

pub fn into_inner(self) -> K::Extractor

Consumes the limit and returns the inner extractor, allowing direct access to the underlying mechanism.

Trait Implementations

impl<const COUNT: usize, const PER: u64, K> AsMut<<K as Key>::Extractor> for Limit<COUNT, PER, K>

where K: Key,

fn as_mut(&mut self) -> &mut K::Extractor

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const COUNT: usize, const PER: u64, K> AsRef<<K as Key>::Extractor> for Limit<COUNT, PER, K>

where K: Key,

fn as_ref(&self) -> &K::Extractor

Converts this type into a shared reference of the (usually inferred) input type.

impl<const COUNT: usize, const PER: u64, K> Clone for Limit<COUNT, PER, K>

where K: Key + Clone, K::Extractor: Clone,

fn clone(&self) -> Limit<COUNT, PER, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const COUNT: usize, const PER: u64, K> Debug for Limit<COUNT, PER, K>

where K: Key + Debug, K::Extractor: Debug,

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

Formats the value using the given formatter.

impl<const COUNT: usize, const PER: u64, K> Default for Limit<COUNT, PER, K>

where K: Key + Default, K::Extractor: Default,

fn default() -> Limit<COUNT, PER, K>

Returns the “default value” for a type.

impl<const COUNT: usize, const PER: u64, K> Deref for Limit<COUNT, PER, K>

where K: Key,

type Target = <K as Key>::Extractor

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const COUNT: usize, const PER: u64, K> DerefMut for Limit<COUNT, PER, K>

where K: Key,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const COUNT: usize, const PER: u64, K> Display for Limit<COUNT, PER, K>

where K: Key, K::Extractor: Display,

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

Formats the value using the given formatter.

impl<const C: usize, const P: u64, K, S> FromRequestParts<S> for Limit<C, P, K>

where LimitState<K>: FromRef<S>, S: Send + Sync, K: Key, K::Extractor: FromRequestParts<S>,

type Rejection = LimitRejection<<<K as Key>::Extractor as FromRequestParts<S>>::Rejection>

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.

impl<const COUNT: usize, const PER: u64, K> Copy for Limit<COUNT, PER, K>

where K: Key + Copy, K::Extractor: Copy,