Struct Request 

pub struct Request { /* private fields */ }

HTTP request

A request is composed of:

• HTTP method (GET, POST, PUT, DELETE, … )
• Target URL, for example, https://myservice.com/users
• (optional) Request headers.
• (optional) Request path parameters, for example, id in the URL https://myservice.com/users?id=1111.
• (optional) Server cookies
• (optional) Request body

Request headers, parameters and cookies are represented by a pair of name and value strings.

For more information see HTTP Request.

Implementations

impl Request

pub fn new<S>(method: HttpMethod, url: S) -> Request

where S: Into<String>,

Hidden constructor

pub fn connect<S>(url: S) -> Request

where S: Into<String>,

Creates a CONNECT request builder

pub fn delete<S>(url: S) -> Request

where S: Into<String>,

Creates a DELETE request builder

pub fn get<S>(url: S) -> Request

where S: Into<String>,

Creates a GET request builder

pub fn head<S>(url: S) -> Request

where S: Into<String>,

Creates a HEAD request builder

pub fn options<S>(url: S) -> Request

where S: Into<String>,

Creates a OPTIONS request builder

pub fn patch<S>(url: S) -> Request

where S: Into<String>,

Creates a PATCH request builder

pub fn post<S>(url: S) -> Request

where S: Into<String>,

Creates a POST request builder

pub fn put<S>(url: S) -> Request

where S: Into<String>,

Creates a PUT request builder

pub fn trace<S>(url: S) -> Request

where S: Into<String>,

Creates a TRACE request builder

pub fn method(&self) -> HttpMethod

Gets HTTP Method

pub fn insert_param<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Into<String>,

Insert a request param with key and value. Param keys are case-sensitive.

pub fn params(&self) -> &KeyValueMap

Gets a params map reference

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

Gets a mutable params map reference

pub fn insert_cookie<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Into<String>,

Insert a cookie param with key and value. Param keys are case-sensitive.

pub fn cookies(&self) -> &KeyValueMap

Gets a cookie map reference

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

Gets a mutable params map reference

pub fn target(&self) -> &str

Gets the target URL as an string

pub fn url(&self) -> Option<&Url>

Gets url::Url reference if target is well-formed

Methods from Deref<Target = HttpMessage>

pub fn insert_header<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Into<String>,

Inserts a header with key and value

pub fn headers(&self) -> &HeaderMap

Gets the headers map

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

Gets a mutable reference to the headers map

pub fn has_single_body(&self) -> bool

Checks if the request has a single body

pub fn has_multipart_body(&self) -> bool

Checks if the request has a multi-part body

pub fn set_body(&mut self, data: Vec<u8>) -> &mut Self

Sets a single body

pub fn body(&self) -> Option<&Vec<u8>>

Gets body data if any, returns None if there is no single body

pub fn set_json(&mut self, data: &JsonValue) -> &mut Self

Sets a json object as request body. The data object is marshaled into a buffer using UTF8 coding. Returns true if request body is overriden

pub fn json(&self) -> Result<JsonValue, Error>

Checks if the Response has body and tries to parse as a `json::JsonValue’

Trait Implementations

impl Deref for Request

type Target = HttpMessage

The resulting type after dereferencing.

fn deref(&self) -> &HttpMessage

Dereferences the value.

impl DerefMut for Request

fn deref_mut(&mut self) -> &mut HttpMessage

Mutably dereferences the value.

impl Display for Request

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

Formats the value using the given formatter.