Struct Request

pub struct Request { /* private fields */ }

Represents an HTTP request.

Stores all the properties of the client’s request.

Implementations

impl Request

pub fn new() -> Request

Creates a new blank Request

pub fn from_hyper<B>(req: Request<B>, scheme: Scheme) -> Request

where B: Into<ReqBody>,

Creates a new Request from hyper::Request.

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

Examples

let req = Request::default();
assert_eq!(*req.uri(), *"/");

pub fn uri_mut(&mut self) -> &mut Uri

Returns a mutable reference to the associated URI.

Notice: If you using this mutable reference to change the uri, you should change the params and queries manually.

Examples

let mut req: Request= Request::default();
*req.uri_mut() = "/hello".parse().unwrap();
assert_eq!(*req.uri(), *"/hello");

pub fn set_uri(&mut self, uri: Uri)

Set the associated URI. queries will be reset.

Notice: params will not reset.

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

Examples

let req = Request::default();
assert_eq!(*req.method(), Method::GET);

pub fn method_mut(&mut self) -> &mut Method

Returns a mutable reference to the associated HTTP method.

Examples

let mut request: Request = Request::default();
*request.method_mut() = Method::PUT;
assert_eq!(*request.method(), Method::PUT);

pub fn version(&self) -> Version

Returns the associated version.

pub fn version_mut(&mut self) -> &mut Version

Returns a mutable reference to the associated version.

pub fn scheme(&self) -> &Scheme

Returns the associated scheme.

pub fn scheme_mut(&mut self) -> &mut Scheme

Returns a mutable reference to the associated scheme.

pub fn remote_addr(&self) -> &SocketAddr

Get request remote address.

pub fn remote_addr_mut(&mut self) -> &mut SocketAddr

Get request remote address.

pub fn local_addr(&self) -> &SocketAddr

Get request local address reference.

pub fn local_addr_mut(&mut self) -> &mut SocketAddr

Get mutable request local address reference.

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header field map.

Examples

let req = Request::default();
assert!(req.headers().is_empty());

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns a mutable reference to the associated header field map.

Examples

let mut req: Request = Request::default();
req.headers_mut().insert(HOST, HeaderValue::from_static("world"));
assert!(!req.headers().is_empty());

pub fn header<'de, T>(&'de self, key: impl AsHeaderName) -> Option<T>

where T: Deserialize<'de>,

Get header with supplied name and try to parse to a ‘T’.

Returns None if failed or not found.

pub fn try_header<'de, T>( &'de self, key: impl AsHeaderName, ) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get header with supplied name and try to parse to a ‘T’.

pub fn add_header<N, V>( &mut self, name: N, value: V, overwrite: bool, ) -> Result<&mut Request, Error>

where N: IntoHeaderName, V: TryInto<HeaderValue>,

Modify a header for this request.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

pub fn body(&self) -> &ReqBody

Returns a reference to the associated HTTP body.

pub fn body_mut(&mut self) -> &mut ReqBody

Returns a mutable reference to the associated HTTP body.

pub fn replace_body(&mut self, body: ReqBody) -> ReqBody

Sets body to a new value and returns old value.

pub fn take_body(&mut self) -> ReqBody

Take body form the request, and set the body to None in the request.

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

Examples

let req = Request::default();
assert!(req.extensions().get::<i32>().is_none());

pub fn set_secure_max_size(&mut self, size: usize)

Set secure max size, default value is 64KB.

pub fn secure_max_size(&self) -> usize

Get secure max size, default value is 64KB.

pub fn extensions_mut(&mut self) -> &mut Extensions

Returns a mutable reference to the associated extensions.

Examples

let mut req = Request::default();
req.extensions_mut().insert("hello");
assert_eq!(req.extensions().get(), Some(&"hello"));

pub fn accept(&self) -> Vec<Mime>

Get accept.

pub fn first_accept(&self) -> Option<Mime>

Get first accept.

pub fn content_type(&self) -> Option<Mime>

Get content type.

pub fn cookies(&self) -> &CookieJar

Get CookieJar reference.

pub fn cookies_mut(&mut self) -> &mut CookieJar

Get CookieJar mutable reference.

pub fn cookie<T>(&self, name: T) -> Option<&Cookie<'static>>

where T: AsRef<str>,

Get Cookie from cookies.

pub fn params(&self) -> &PathParams

Get params reference.

pub fn params_mut(&mut self) -> &mut PathParams

Get params mutable reference.

pub fn param<'de, T>(&'de self, key: &str) -> Option<T>

where T: Deserialize<'de>,

Get param value from params.

pub fn try_param<'de, T>(&'de self, key: &str) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get param value from params.

pub fn queries(&self) -> &MultiMap<String, String>

Get queries reference.

pub fn queries_mut(&mut self) -> &mut MultiMap<String, String>

Get mutable queries reference.

pub fn query<'de, T>(&'de self, key: &str) -> Option<T>

where T: Deserialize<'de>,

Get query value from queries.

pub fn try_query<'de, T>(&'de self, key: &str) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get query value from queries.

pub async fn form<'de, T>(&'de mut self, key: &str) -> Option<T>

where T: Deserialize<'de>,

Get field data from form.

pub async fn try_form<'de, T>(&'de mut self, key: &str) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get field data from form.

pub async fn form_or_query<'de, T>(&'de mut self, key: &str) -> Option<T>

where T: Deserialize<'de>,

Get field data from form, if key is not found in form data, then get from query.

pub async fn try_form_or_query<'de, T>( &'de mut self, key: &str, ) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get field data from form, if key is not found in form data, then get from query.

pub async fn query_or_form<'de, T>(&'de mut self, key: &str) -> Option<T>

where T: Deserialize<'de>,

Get value from query, if key is not found in queries, then get from form.

pub async fn try_query_or_form<'de, T>( &'de mut self, key: &str, ) -> Result<T, ParseError>

where T: Deserialize<'de>,

Try to get value from query, if key is not found in queries, then get from form.

pub async fn file(&mut self, key: &str) -> Option<&FilePart>

Get FilePart reference from request.

pub async fn try_file( &mut self, key: &str, ) -> Result<Option<&FilePart>, ParseError>

Try to get FilePart reference from request.

pub async fn first_file(&mut self) -> Option<&FilePart>

Get FilePart reference from request.

pub async fn try_first_file(&mut self) -> Result<Option<&FilePart>, ParseError>

Try to get FilePart reference from request.

pub async fn files(&mut self, key: &str) -> Option<&Vec<FilePart>>

Get FilePart list reference from request.

pub async fn try_files( &mut self, key: &str, ) -> Result<Option<&Vec<FilePart>>, ParseError>

Try to get FilePart list reference from request.

pub async fn all_files(&mut self) -> Vec<&FilePart>

Get FilePart list reference from request.

pub async fn try_all_files(&mut self) -> Result<Vec<&FilePart>, ParseError>

Try to get FilePart list reference from request.

pub async fn payload(&mut self) -> Result<&Bytes, ParseError>

Get request payload with default max size limit(64KB).

https://github.com/hyperium/hyper/issues/3111 *Notice: This method takes body.

pub async fn payload_with_max_size( &mut self, max_size: usize, ) -> Result<&Bytes, ParseError>

Get request payload with max size limit.

https://github.com/hyperium/hyper/issues/3111 *Notice: This method takes body.

pub async fn form_data(&mut self) -> Result<&FormData, ParseError>

Get FormData reference from request.

*Notice: This method takes body and body’s size is not limited.

pub async fn extract<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Extractible<'de> + Deserialize<'de> + Send,

Extract request as type T from request’s different parts.

pub async fn extract_with_metadata<'de, T>( &'de mut self, metadata: &'de Metadata, ) -> Result<T, ParseError>

where T: Deserialize<'de> + Send,

Extract request as type T from request’s different parts.

pub fn parse_params<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse url params as type T from request.

pub fn parse_queries<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse queries as type T from request.

pub fn parse_headers<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse headers as type T from request.

pub fn parse_cookies<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse cookies as type T from request.

pub async fn parse_json<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse json body as type T from request with default max size limit.

pub async fn parse_json_with_max_size<'de, T>( &'de mut self, max_size: usize, ) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse json body as type T from request with max size limit.

pub async fn parse_form<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse form body as type T from request.

pub async fn parse_body<'de, T>(&'de mut self) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse json body or form body as type T from request with default max size.

pub async fn parse_body_with_max_size<'de, T>( &'de mut self, max_size: usize, ) -> Result<T, ParseError>

where T: Deserialize<'de>,

Parse json body or form body as type T from request with max size.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.