Struct HttpRouteMatch

#[non_exhaustive]
pub struct HttpRouteMatch {
    pub prefix: Option<String>,
    pub path: Option<HttpPathMatch>,
    pub query_parameters: Option<Vec<HttpQueryParameter>>,
    pub method: Option<HttpMethod>,
    pub scheme: Option<HttpScheme>,
    pub headers: Option<Vec<HttpRouteHeader>>,
    pub port: Option<i32>,
}

An object that represents the requirements for a route to match HTTP requests for a virtual router.

Fields (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.

prefix: Option<String>

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

path: Option<HttpPathMatch>

The client request path to match on.

query_parameters: Option<Vec<HttpQueryParameter>>

The client request query parameters to match on.

method: Option<HttpMethod>

The client request method to match on. Specify only one.

scheme: Option<HttpScheme>

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

headers: Option<Vec<HttpRouteHeader>>

The client request headers to match on.

port: Option<i32>

The port number to match on.

Implementations

impl HttpRouteMatch

pub fn prefix(&self) -> Option<&str>

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

pub fn path(&self) -> Option<&HttpPathMatch>

The client request path to match on.

pub fn query_parameters(&self) -> &[HttpQueryParameter]

The client request query parameters to match on.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .query_parameters.is_none().

pub fn method(&self) -> Option<&HttpMethod>

The client request method to match on. Specify only one.

pub fn scheme(&self) -> Option<&HttpScheme>

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

pub fn headers(&self) -> &[HttpRouteHeader]

The client request headers to match on.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .headers.is_none().

pub fn port(&self) -> Option<i32>

The port number to match on.

impl HttpRouteMatch

pub fn builder() -> HttpRouteMatchBuilder

Creates a new builder-style object to manufacture HttpRouteMatch.

Trait Implementations

impl Clone for HttpRouteMatch

fn clone(&self) -> HttpRouteMatch

Returns a duplicate 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 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 StructuralPartialEq for HttpRouteMatch