Struct RateLimitingRule

pub struct RateLimitingRule {
    pub block_duration: NonZeroU64,
    pub conditions: Option<RateLimitingRuleConditions>,
    pub key: Vec<RateLimitingRuleKeyItem>,
    pub limit: NonZeroU64,
    pub rank: NonZeroU64,
    pub window: RateLimitingRuleWindow,
}

A RateLimitingRule defines a rate limiting rule for the project.

JSON schema

{
 "description": "A RateLimitingRule defines a rate limiting rule for the project.",
 "type": "object",
 "required": [
   "limit",
   "rank"
 ],
 "properties": {
   "block_duration": {
     "description": "Duration to block the client if rate limit is exceeded (in seconds).",
     "default": 60,
     "type": "integer",
     "minimum": 1.0
   },
   "conditions": {
     "description": "Conditions that must be met for this rule to apply.",
     "type": "object",
     "properties": {
       "continent": {
         "description": "Continents that this rule applies to.",
         "type": "array",
         "items": {
           "type": "string",
           "enum": [
             "AF",
             "AN",
             "AS",
             "EU",
             "NA",
             "OC",
             "SA"
           ]
         }
       },
       "country": {
         "description": "Countries (ISO 3166-1 alpha-2 codes) that this rule applies to.",
         "type": "array",
         "items": {
           "type": "string",
           "pattern": "^[A-Z]{2}$"
         }
       },
       "method": {
         "description": "HTTP methods that this rule applies to.",
         "type": "array",
         "items": {
           "type": "string",
           "enum": [
             "GET",
             "POST",
             "PUT",
             "DELETE",
             "PATCH",
             "HEAD",
             "OPTIONS",
             "TRACE"
           ]
         }
       },
       "path": {
         "description": "Path pattern to match. Can be exact path or regex pattern.",
         "type": "string"
       },
       "regex": {
         "description": "Whether the path is a regex pattern.",
         "default": false,
         "type": "boolean"
       }
     }
   },
   "key": {
     "description": "Criteria to include in the client key for rate limiting.",
     "default": [
       "ip"
     ],
     "type": "array",
     "items": {
       "type": "string",
       "enum": [
         "ip",
         "ua"
       ]
     }
   },
   "limit": {
     "description": "Maximum requests per second within the rate window.",
     "type": "integer",
     "minimum": 1.0
   },
   "rank": {
     "description": "The rank of the rule. Rules are evaluated in order of rank (lowest first).",
     "type": "integer",
     "minimum": 1.0
   },
   "window": {
     "description": "Rate window for counting requests.",
     "default": "10s",
     "type": "string",
     "enum": [
       "1s",
       "10s",
       "60s"
     ]
   }
 }
}

Fields

block_duration: NonZeroU64

Duration to block the client if rate limit is exceeded (in seconds).

conditions: Option<RateLimitingRuleConditions>

key: Vec<RateLimitingRuleKeyItem>

Criteria to include in the client key for rate limiting.

limit: NonZeroU64

Maximum requests per second within the rate window.

rank: NonZeroU64

The rank of the rule. Rules are evaluated in order of rank (lowest first).

window: RateLimitingRuleWindow

Rate window for counting requests.

Implementations

impl RateLimitingRule

pub fn builder() -> RateLimitingRule

Trait Implementations

impl Clone for RateLimitingRule

fn clone(&self) -> RateLimitingRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitingRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitingRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&RateLimitingRule> for RateLimitingRule

fn from(value: &RateLimitingRule) -> Self

Converts to this type from the input type.

impl From<RateLimitingRule> for RateLimitingRule

fn from(value: RateLimitingRule) -> Self

Converts to this type from the input type.

impl JsonSchema for RateLimitingRule

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 Serialize for RateLimitingRule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RateLimitingRule> for RateLimitingRule

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: RateLimitingRule) -> Result<Self, ConversionError>

Performs the conversion.