Struct RateLimiterConfig

pub struct RateLimiterConfig {
    pub behind_proxy: bool,
    pub per_second: u64,
    pub burst_size: u32,
}

Configurations for rate limitng.

Fields

behind_proxy: bool

Enable rate limit based on headers commonly used by reverse proxies.

Uses headers commonly used by reverse proxies to extract the original IP address, falling back to the connection’s peer IP address. https://docs.rs/tower_governor/latest/tower_governor/key_extractor/struct.SmartIpKeyExtractor.html

per_second: u64

Set the interval after which one element of the quota is replenished in seconds.

The interval must not be zero.

burst_size: u32

Set quota size that defines how many requests can occur before the governor middleware starts blocking requests from an IP address and clients have to wait until the elements of the quota are replenished.

The burst_size must not be zero.

Trait Implementations

impl Debug for RateLimiterConfig

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

Formats the value using the given formatter.

impl Default for RateLimiterConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimiterConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RateLimiterConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.