Struct RateLimit 

pub struct RateLimit {
    pub name: Option<String>,
    pub algorithm: Option<String>,
    pub limit: Option<i64>,
    pub window_millis: Option<i64>,
    pub burst: Option<i64>,
    pub refill_per_second: Option<f64>,
    pub error_status: Option<i32>,
    pub retry_after: Option<String>,
    pub extra: Extra,
}

Declarative, protocol-agnostic rate limit / quota attached to an expectation.

Fields

name: Option<String>

algorithm: Option<String>

"fixed_window" (default) or "token_bucket".

limit: Option<i64>

window_millis: Option<i64>

burst: Option<i64>

refill_per_second: Option<f64>

error_status: Option<i32>

retry_after: Option<String>

extra: Extra

Implementations

impl RateLimit

pub fn new() -> Self

Create a new empty rate limit.

pub fn fixed_window(limit: i64, window_millis: i64) -> Self

Create a fixed_window rate limit of limit requests per window_millis.

pub fn token_bucket(burst: i64, refill_per_second: f64) -> Self

Create a token_bucket rate limit with burst capacity refilled at refill_per_second tokens per second.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Default for RateLimit

fn default() -> RateLimit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RateLimit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RateLimit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RateLimit