Skip to main content

RateLimitConfig

Struct RateLimitConfig 

Source
pub struct RateLimitConfig {
    pub enable_rate_limiting: bool,
    pub rate_limit: u32,
    pub rate_limit_window: u64,
    pub enable_rate_limit_auto_ban: bool,
    pub endpoint_rate_limits: HashMap<String, RateLimitEntry>,
}
Expand description

The rate-limiting knobs (the reference enable_rate_limiting / rate_limit / rate_limit_window / enable_rate_limit_auto_ban group).

The defaults are the reference SecurityConfig defaults: rate limiting on (enable_rate_limiting = true, guard_core/_security_config_fields.py) with the reference thresholds (10 requests / 60 s window).

Fields§

§enable_rate_limiting: bool

enable_rate_limiting. false makes every RateLimiter::check an unconditional allow that records nothing.

§rate_limit: u32

rate_limit: maximum requests per client IP inside rate_limit_window seconds.

§rate_limit_window: u64

rate_limit_window: the window length in seconds.

§enable_rate_limit_auto_ban: bool

enable_rate_limit_auto_ban: feed rate-limit crossings into the auto-ban engine (the rate_limit category of the violation counters) when the pipeline stage runs with IP banning enabled.

§endpoint_rate_limits: HashMap<String, RateLimitEntry>

endpoint_rate_limits: the per-endpoint tier map (path -> (requests, window), the reference config field set by dynamic rules), matched by exact path. Empty by default: the tier is unconfigured and records nothing.

Trait Implementations§

Source§

impl Clone for RateLimitConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimitConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RateLimitConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for RateLimitConfig

Source§

impl PartialEq for RateLimitConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RateLimitConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.