Struct Route 

#[non_exhaustive]
pub struct Route {
    pub name: String,
    pub host: String,
    pub path_prefix: String,
    pub upstreams: Vec<String>,
    pub strip_prefix: bool,
    pub upstream_host: String,
    pub selection: Selection,
}

One route: a match rule and an upstream pool.

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.

name: String

Unique name, used in metrics and logs. Letters, digits, _, - and . only. fallback and unmatched are reserved.

host: String

Host to match: api.example.com or *.example.com. Empty: any host. The match ignores case and the port.

path_prefix: String

Path prefix to match, on a segment boundary: /api matches /api and /api/x, not /apix. Default: /.

upstreams: Vec<String>

Upstream addresses, host:port. Hostnames resolve at boot.

strip_prefix: bool

Remove path_prefix before the request goes upstream. Default: false.

upstream_host: String

Host header for the upstream. Empty: keep the client Host.

selection: Selection

How to pick an upstream. Default: round_robin.

Implementations

impl Route

pub fn new(name: impl Into<String>) -> Self

A route with name, the root prefix and no upstreams.

pub fn host(self, host: impl Into<String>) -> Self

Match this host: api.example.com or *.example.com.

pub fn path_prefix(self, prefix: impl Into<String>) -> Self

Match this path prefix.

pub fn upstream(self, upstream: impl Into<String>) -> Self

Add an upstream, host:port.

pub fn upstreams<I, S>(self, upstreams: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add upstreams, host:port.

pub const fn strip_prefix(self, strip: bool) -> Self

Remove the prefix before the request goes upstream.

pub fn upstream_host(self, host: impl Into<String>) -> Self

Send this Host header upstream.

pub const fn selection(self, selection: Selection) -> Self

Pick upstreams with selection.

pub fn validate(&self) -> Result<(), ConfigError>

Reject a route that cannot work.

Errors

Returns ConfigError that names the route and the key.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Default for Route

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Route

where Route: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Route

impl PartialEq for Route

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Route

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Route