Struct ShieldConfig 

#[non_exhaustive]
pub struct ShieldConfig {
    pub enabled: bool,
    pub endpoint_classes: Vec<EndpointClassConfig>,
    pub identifier_endpoints: Vec<IdentifierEndpointConfig>,
    pub window_secs: u64,
    pub redis_url: Option<String>,
    pub trusted_proxies: Vec<String>,
}

Shield (rate limiting) configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

endpoint_classes: Vec<EndpointClassConfig>

Endpoint classification (glob pattern → class → rate limit).

identifier_endpoints: Vec<IdentifierEndpointConfig>

Per-identifier rate limiting.

window_secs: u64

Window size in seconds (default: 60).

redis_url: Option<String>

Redis URL for shared counters across replicas (e.g. “redis://127.0.0.1/”). When unset, an in-process per-replica store is used. Requires the redis build feature; otherwise the proxy logs a warning and uses the in-process store.

trusted_proxies: Vec<String>

CIDR ranges of trusted reverse proxies / load balancers (e.g. “10.0.0.0/8”). X-Forwarded-For / X-Real-IP are honored only when the direct peer falls in one of these ranges; otherwise the peer socket address is used as the client identity. Empty (the default) means do not trust forwarding headers — set this behind a load balancer.

Trait Implementations

impl Clone for ShieldConfig

fn clone(&self) -> ShieldConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShieldConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShieldConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.