Struct RateLimitingRuleConditions

pub struct RateLimitingRuleConditions {
    pub continent: Vec<RateLimitingRuleConditionsContinentItem>,
    pub country: Vec<RateLimitingRuleConditionsCountryItem>,
    pub method: Vec<RateLimitingRuleConditionsMethodItem>,
    pub path: Option<String>,
    pub regex: bool,
}

Conditions that must be met for this rule to apply.

JSON schema

{
 "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"
   }
 }
}

Fields

continent: Vec<RateLimitingRuleConditionsContinentItem>

Continents that this rule applies to.

country: Vec<RateLimitingRuleConditionsCountryItem>

Countries (ISO 3166-1 alpha-2 codes) that this rule applies to.

method: Vec<RateLimitingRuleConditionsMethodItem>

HTTP methods that this rule applies to.

path: Option<String>

Path pattern to match. Can be exact path or regex pattern.

regex: bool

Whether the path is a regex pattern.

Implementations

impl RateLimitingRuleConditions

pub fn builder() -> RateLimitingRuleConditions

Trait Implementations

impl Clone for RateLimitingRuleConditions

fn clone(&self) -> RateLimitingRuleConditions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitingRuleConditions

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

Formats the value using the given formatter.

impl Default for RateLimitingRuleConditions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimitingRuleConditions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&RateLimitingRuleConditions> for RateLimitingRuleConditions

fn from(value: &RateLimitingRuleConditions) -> Self

Converts to this type from the input type.

impl From<RateLimitingRuleConditions> for RateLimitingRuleConditions

fn from(value: RateLimitingRuleConditions) -> Self

Converts to this type from the input type.

impl JsonSchema for RateLimitingRuleConditions

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 RateLimitingRuleConditions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RateLimitingRuleConditions> for RateLimitingRuleConditions

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.