Struct RateLimitPolicy 

pub struct RateLimitPolicy {
    pub requests: NonZeroU32,
    pub period: Duration,
    pub burst: Option<NonZeroU32>,
    pub scope: RateLimitScope,
}

Declarative rate limit translated by an HTTP or rate-limiter adapter.

Fields

requests: NonZeroU32

Maximum steady-state requests in the period.

period: Duration

Length of the rate-limit period.

burst: Option<NonZeroU32>

Optional additional burst capacity.

scope: RateLimitScope

Dimension used to derive the limiter key.

Implementations

impl RateLimitPolicy

pub fn new(requests: NonZeroU32, period: Duration) -> SoapResult<Self>

Creates a client-IP rate limit with a non-zero period.

pub fn scope(self, scope: RateLimitScope) -> Self

Selects the identity dimension used to derive a limiter key.

pub fn burst(self, burst: NonZeroU32) -> Self

Adds explicit burst capacity above the steady-state limit.

pub fn validate(&self) -> SoapResult<()>

Validates invariants after direct public-field mutation.

Trait Implementations

impl Clone for RateLimitPolicy

fn clone(&self) -> RateLimitPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitPolicy

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

Formats the value using the given formatter.

impl Eq for RateLimitPolicy

impl PartialEq for RateLimitPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateLimitPolicy