Struct highnoon::request::Request

pub struct Request<S: Sync + 'static> { /* fields omitted */ }

An incoming request

Implementations

impl<S: Send + Sync + 'static> Request<S>

pub fn state(&self) -> &S

Get a reference to the App's state

pub fn method(&self) -> &Method

Get the HTTP method being used by this request

pub fn uri(&self) -> &Uri

Get the URI that was used for this request

pub fn query<T: DeserializeOwned>(&self) -> Result<T>

Parse the URI query string into an instance of T that derives Deserialize.

(To get the raw query string access it via req.uri().query()). If there is no query string, deserialize an empty string.

pub fn header<T: Header>(&self) -> Option<T>

Get a typed header from the request (See also headers)

pub fn headers(&self) -> &HeaderMap<HeaderValue>

Get all headers as a HeaderMap

pub fn param(&self, param: &str) -> Result<&str>

Get a route parameter (eg. :key or *key segments in the URI path)

pub fn params(&self) -> &Params

Get all route parameters

pub async fn body_mut(&mut self) -> Result<&mut Body>

Get the request body as a hyper::Body

pub async fn reader(&mut self) -> Result<impl Read + '_>

Get a reader to read the request body

(This does buffer the whole body into memory (not necessarily contiguous memory). If you need to protect against malicious clients you should access the body via body_mut

pub async fn body_bytes(&mut self) -> Result<Vec<u8>>

Get the request body as raw bytes in a Vec<u8>

pub async fn body_string(&mut self) -> Result<String>

Get the request body as UTF-8 data in String

pub async fn body_json<T: DeserializeOwned>(&mut self) -> Result<T>

Get the request body as JSON and deserialise into T

pub fn remote_addr(&self) -> &SocketAddr

Get the address of the remote peer.

This method uses the network level address only and hwnce may be incorrect if you are behind a proxy. (This does not check for any Forwarded headers etc...)