Struct RateLimitConfig 

pub struct RateLimitConfig {
    pub capacity: u64,
    pub refill_per_sec: u64,
    pub key: KeyConfig,
    pub caps: CapsConfig,
    pub retry_after_ms: Option<u64>,
}

Typed config surface for the rate_limit middleware (token bucket).

Fields

capacity: u64

Token bucket capacity (burst). Required.

refill_per_sec: u64

Steady-state refill rate in tokens per second. Required.

key: KeyConfig

Key-extraction strategy. Flattened so key = "header" + header_name sit at the top level, matching the historical spec.

caps: CapsConfig

Per-key bucket-map caps.

retry_after_ms: Option<u64>

Retry-After (ms) advertised on a 429. None keeps the limiter default.

Implementations

impl RateLimitConfig

pub fn builder() -> RateLimitConfigBuilder

Create an instance of RateLimitConfig using the builder syntax

impl RateLimitConfig

pub fn from_config( self, inner: PipeHandle, ) -> Result<RateLimit<PipeHandle, KeyExtractor, TimeClock>, ProximaError>

Materialise the limiter around inner, on the production TimeClock.

Trait Implementations

impl Clone for RateLimitConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RateLimitConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Settings for RateLimitConfig

const PREFIX: Option<&'static str>

The struct’s own prefix, used only when it is the root of resolution. When embedded as a nested field, the embedding field decides the prefix.

fn from_env() -> Result<Self>

Resolve using the struct’s own PREFIX as the root.

fn from_env_with_prefix(__prefix: &str) -> Result<Self>

Resolve using prefix as the accumulated root instead of PREFIX. Used by parent structs to push their namespace into nested fields.

fn override_from_env(&mut self) -> Result<()>

Overwrite only the fields whose env keys are currently set, leaving the rest untouched. Useful for layering env over file-loaded defaults.

fn override_from_env_with_prefix(&mut self, __prefix: &str) -> Result<()>

override_from_env with an explicit accumulated prefix.

impl Validate for RateLimitConfig

fn validate(&self) -> Result<()>

Check the constructed config, returning Error::Validation with every failure collected, or Ok(()) when all rules pass.