Struct reqwest::async::RequestBuilder
source · pub struct RequestBuilder { /* private fields */ }Expand description
A builder to construct the properties of a Request.
Implementations§
source§impl RequestBuilder
impl RequestBuilder
sourcepub fn header<K, V>(self, key: K, value: V) -> RequestBuilderwhere
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
pub fn header<K, V>(self, key: K, value: V) -> RequestBuilderwhere
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
Add a Header to this Request.
sourcepub fn headers(self, headers: HeaderMap) -> RequestBuilder
pub fn headers(self, headers: HeaderMap) -> RequestBuilder
Add a set of Headers to the existing ones on this Request.
The headers will be merged in to any already set.
sourcepub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> RequestBuilderwhere
U: Display,
P: Display,
pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> RequestBuilderwhere
U: Display,
P: Display,
Enable HTTP basic authentication.
sourcepub fn body<T: Into<Body>>(self, body: T) -> RequestBuilder
pub fn body<T: Into<Body>>(self, body: T) -> RequestBuilder
Set the request body.
sourcepub fn query<T: Serialize + ?Sized>(self, query: &T) -> RequestBuilder
pub fn query<T: Serialize + ?Sized>(self, query: &T) -> RequestBuilder
Modify the query string of the URL.
Modifies the URL of this request, adding the parameters provided.
This method appends and does not overwrite. This means that it can
be called multiple times and that existing query parameters are not
overwritten if the same key is used. The key will simply show up
twice in the query string.
Calling .query([("foo", "a"), ("foo", "b")]) gives "foo=a&foo=b".
Note
This method does not support serializing a single key-value
pair. Instead of using .query(("key", "val")), use a sequence, such
as .query(&[("key", "val")]). It’s also possible to serialize structs
and maps into a key-value pair.
Errors
This method will fail if the object you provide cannot be serialized into a query string.
sourcepub fn json<T: Serialize + ?Sized>(self, json: &T) -> RequestBuilder
pub fn json<T: Serialize + ?Sized>(self, json: &T) -> RequestBuilder
Send a JSON body.
Errors
Serialization can fail if T’s implementation of Serialize decides to
fail, or if T contains a map with non-string keys.