Struct shs::Request

pub struct Request { /* private fields */ }

Requirements for the Server Error type parameter. Request type passed to handlers. It provides both the input request and the output response, as well as access to state shared across requests.

Implementations

impl Request

pub fn url(&self) -> &Url

Get the request URL.

pub fn headers(&self) -> &HashMap<UniCase<String>, String>

Get the request headers.

pub fn read_json<'a, D: Deserialize<'a>>(&'a self) -> Result<D, Error>

Deserialize the body as JSON.

pub fn write_bytes(&mut self, body: &[u8])

Write the input as the response body. This also sets the Content-Type to application/octet-stream.

pub fn write_json<S: Serialize>(&mut self, body: &S) -> Result<(), Error>

Serialize the input as the response body. This also sets the Content-Type to application/json.

pub fn write_text(&mut self, body: &str)

Write the input as the response body with utf-8 encoding. This also sets the Content-Type to text/plain; charset=UTF-8.

pub fn set_status(&mut self, status: StatusCode)

Set the response status code.

pub fn set_not_found(&mut self)

Set the response status code to 404 (not found).

pub fn set_header(&mut self, name: &str, value: &str)

Set a response header.

pub fn set_content_type(&mut self, value: &str)

Set the Content-Type response header.

pub fn path_param<F>(&self, name: &str) -> Result<F, Error>

where F::Err: Error + Send + Sync + 'static, F: FromStr,

Get a path parameter. For example, if an input route “/resource/:key” is defined, the handler can get the “:key” portion by calling path_param("key"). The returned type can be anything that implements FromStr.