Struct MiddlewareRateLimit 

pub struct MiddlewareRateLimit {
    pub average: Option<i64>,
    pub burst: Option<i64>,
    pub period: Option<IntOrString>,
    pub source_criterion: Option<MiddlewareRateLimitSourceCriterion>,
}

RateLimit holds the rate limit configuration. This middleware ensures that services will receive a fair amount of requests, and allows one to define what fair is. More info: https://doc.traefik.io/traefik/v3.3/middlewares/http/ratelimit/

Fields

average: Option<i64>

Average is the maximum rate, by default in requests/s, allowed for the given source. It defaults to 0, which means no rate limiting. The rate is actually defined by dividing Average by Period. So for a rate below 1req/s, one needs to define a Period larger than a second.

burst: Option<i64>

Burst is the maximum number of requests allowed to arrive in the same arbitrarily small period of time. It defaults to 1.

period: Option<IntOrString>

Period, in combination with Average, defines the actual maximum rate, such as: r = Average / Period. It defaults to a second.

source_criterion: Option<MiddlewareRateLimitSourceCriterion>

SourceCriterion defines what criterion is used to group requests as originating from a common source. If several strategies are defined at the same time, an error will be raised. If none are set, the default is to use the request’s remote address field (as an ipStrategy).

Implementations

impl MiddlewareRateLimit

pub fn builder() -> MiddlewareRateLimitBuilder<((), (), (), ())>

Create a builder for building MiddlewareRateLimit. On the builder, call .average(...)(optional), .burst(...)(optional), .period(...)(optional), .source_criterion(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of MiddlewareRateLimit.

Trait Implementations

impl Clone for MiddlewareRateLimit

fn clone(&self) -> MiddlewareRateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MiddlewareRateLimit

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

Formats the value using the given formatter.

impl Default for MiddlewareRateLimit

fn default() -> MiddlewareRateLimit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MiddlewareRateLimit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MiddlewareRateLimit

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MiddlewareRateLimit

fn eq(&self, other: &MiddlewareRateLimit) -> 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 MiddlewareRateLimit

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 MiddlewareRateLimit