Struct HttpRouteMatch

pub struct HttpRouteMatch {
    pub path: Option<HttpPathMatch>,
    pub headers: Option<Vec<HttpHeaderMatch>>,
    pub query_params: Option<Vec<HttpQueryParamMatch>>,
    pub method: Option<HttpMethod>,
}

HTTPRouteMatch defines the predicate used to match requests to a given action. Multiple match types are ANDed together, i.e. the match will evaluate to true only if all conditions are satisfied.

For example, the match below will match a HTTP request only if its path starts with /foo AND it contains the version: v1 header:

match:
  path:
    value: "/foo"
  headers:
  - name: "version"
    value "v1"

Fields

path: Option<HttpPathMatch>

Path specifies a HTTP request path matcher. If this field is not specified, a default prefix match on the “/” path is provided.

headers: Option<Vec<HttpHeaderMatch>>

Headers specifies HTTP request header matchers. Multiple match values are ANDed together, meaning, a request must match all the specified headers to select the route.

query_params: Option<Vec<HttpQueryParamMatch>>

QueryParams specifies HTTP query parameter matchers. Multiple match values are ANDed together, meaning, a request must match all the specified query parameters to select the route.

method: Option<HttpMethod>

Method specifies HTTP method matcher.

When specified, this route will be matched only if the request has the specified method.

Support: Extended

Trait Implementations

impl Clone for HttpRouteMatch

fn clone(&self) -> HttpRouteMatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRouteMatch

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

Formats the value using the given formatter.

impl Default for HttpRouteMatch

fn default() -> HttpRouteMatch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpRouteMatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HttpRouteMatch

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 HttpRouteMatch

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HttpRouteMatch

impl StructuralPartialEq for HttpRouteMatch