Struct Request 

#[non_exhaustive]
pub struct Request<'conn> {
    pub method: Method,
    pub authority: String,
    pub path: String,
    pub raw_query: String,
    pub body: Box<dyn Read + 'conn>,
    pub headers: Headers,
    pub path_values: BTreeMap<String, String>,
    pub cookies: Vec<(String, String)>,
    pub ip: SocketAddr,
    pub shutdown: Signal,
}

An incoming http request

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.

method: Method

The request method

authority: String

The authority portion of the url

path: String

The url path

raw_query: String

The query string

Use Request::parse_query to parse it

body: Box<dyn Read + 'conn>

The request body

headers: Headers

The request headers

path_values: BTreeMap<String, String>

The values of the matched path patterns from PathRouter.

Can also be used to store arbitrary values for downstream http handlers

cookies: Vec<(String, String)>

Cookie pairs present on this request.

ip: SocketAddr

The address of the HTTP client

shutdown: Signal

A signal that the server is shutting down.

Request handlers that perform long running tasks should periodically use this to check if a server is requesting a shutdown.

Implementations

impl Request<'_>

pub fn parse_query(&self) -> UrlEncodedParams

Returns the parsed query string

pub fn parse_form_body(&mut self) -> Result<UrlEncodedParams>

Attempts to parse the body as application/x-www-form-urlencoded

This function consumes the body stream.