axum-limit 0.1.0

Production-oriented rate limiting for Axum via extractors, with pluggable algorithms, storage backends, and dynamic quotas.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use crate::quota::Quota;
use axum_core::extract::FromRef;
use axum_core::response::IntoResponse;
use http::request::Parts;
use std::convert::Infallible;

/// Resolves a [`Quota`] at request time.
///
/// Types that implement [`FromRef`] and [`Into<Quota>`] receive a blanket implementation.
pub trait QuotaSource<S>: Send + Sync + Sized + 'static {
    /// Error returned when quota resolution fails.
    type Rejection: IntoResponse;

    /// Resolves the quota for the current request.
    fn resolve(
        parts: &Parts,
        state: &S,
    ) -> impl std::future::Future<Output = Result<Quota, Self::Rejection>> + Send;
}

impl<S, Q> QuotaSource<S> for Q
where
    Q: FromRef<S> + Into<Quota> + Send + Sync + 'static,
    S: Sync,
{
    type Rejection = Infallible;

    fn resolve(
        _parts: &Parts,
        state: &S,
    ) -> impl std::future::Future<Output = Result<Quota, Self::Rejection>> + Send {
        let quota = Q::from_ref(state).into();
        async move { Ok(quota) }
    }
}

/// Resolves a fixed [`Quota`] stored in application state.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FixedQuota(pub Quota);

impl From<FixedQuota> for Quota {
    fn from(value: FixedQuota) -> Self {
        value.0
    }
}