#[non_exhaustive]
pub struct RuleCondition { pub field: Option<String>, pub values: Option<Vec<String>>, pub host_header_config: Option<HostHeaderConditionConfig>, pub path_pattern_config: Option<PathPatternConditionConfig>, pub http_header_config: Option<HttpHeaderConditionConfig>, pub query_string_config: Option<QueryStringConditionConfig>, pub http_request_method_config: Option<HttpRequestMethodConditionConfig>, pub source_ip_config: Option<SourceIpConditionConfig>, }
Expand description

Information about a condition for a rule.

Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.

Fields (Non-exhaustive)

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
field: Option<String>

The field in the HTTP request. The following are the possible values:

  • http-header

  • http-request-method

  • host-header

  • path-pattern

  • query-string

  • source-ip

values: Option<Vec<String>>

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • - .

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ " ' @ : +

  • & (using &)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

host_header_config: Option<HostHeaderConditionConfig>

Information for a host header condition. Specify only when Field is host-header.

path_pattern_config: Option<PathPatternConditionConfig>

Information for a path pattern condition. Specify only when Field is path-pattern.

http_header_config: Option<HttpHeaderConditionConfig>

Information for an HTTP header condition. Specify only when Field is http-header.

query_string_config: Option<QueryStringConditionConfig>

Information for a query string condition. Specify only when Field is query-string.

http_request_method_config: Option<HttpRequestMethodConditionConfig>

Information for an HTTP method condition. Specify only when Field is http-request-method.

source_ip_config: Option<SourceIpConditionConfig>

Information for a source IP condition. Specify only when Field is source-ip.

Implementations

The field in the HTTP request. The following are the possible values:

  • http-header

  • http-request-method

  • host-header

  • path-pattern

  • query-string

  • source-ip

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • - .

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ " ' @ : +

  • & (using &)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

Information for a host header condition. Specify only when Field is host-header.

Information for a path pattern condition. Specify only when Field is path-pattern.

Information for an HTTP header condition. Specify only when Field is http-header.

Information for a query string condition. Specify only when Field is query-string.

Information for an HTTP method condition. Specify only when Field is http-request-method.

Information for a source IP condition. Specify only when Field is source-ip.

Creates a new builder-style object to manufacture RuleCondition

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more