Struct Route 

pub struct Route {
    pub name: String,
    pub host: Option<String>,
    pub path_prefix: String,
    pub methods: Vec<String>,
    pub headers: Vec<(String, String)>,
    pub priority: i32,
    pub document_root: PathBuf,
    pub compression: Option<bool>,
}

One routing rule: request constraints and the document root it serves.

Fields

name: String

Unique name, used in errors and diagnostics.

host: Option<String>

Host the request must name (the Host header without its port, compared case-insensitively). None matches any host.

path_prefix: String

Path prefix, matched on segment boundaries: /docs matches /docs and /docs/a.html, not /docsx. / matches every path.

methods: Vec<String>

Allowed methods. Empty allows every method.

headers: Vec<(String, String)>

Headers that must be present with exactly this value. Names are compared case-insensitively.

priority: i32

Higher values are tried first. Defaults to 0.

document_root: PathBuf

Directory served for requests that match this route.

compression: Option<bool>

Some(false) serves this route uncompressed whatever the server’s CompressionPolicy; None or Some(true) follows the server.

Implementations

impl Route

pub fn new( name: &str, path_prefix: &str, document_root: impl Into<PathBuf>, ) -> Self

Creates a route that serves document_root under path_prefix.

pub fn host(self, host: &str) -> Self

Restricts the route to one host.

pub fn method(self, method: &str) -> Self

Adds an allowed method.

pub fn header(self, name: &str, value: &str) -> Self

Requires a header with an exact value.

pub fn priority(self, priority: i32) -> Self

Sets the priority; higher is tried first.

pub fn compression(self, enabled: bool) -> Self

Switches compression on or off for this route.

pub fn matches(&self, request: &Request) -> bool

Whether request meets every constraint of this route.

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<'de> Deserialize<'de> for Route

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