Struct reqwest::unstable::async::RequestBuilder
[−]
[src]
pub struct RequestBuilder { /* fields omitted */ }
A builder to construct the properties of a Request
.
Methods
impl RequestBuilder
[src]
fn header<H>(&mut self, header: H) -> &mut RequestBuilder where
H: Header,
[src]
H: Header,
Add a Header
to this Request.
fn headers(&mut self, headers: Headers) -> &mut RequestBuilder
[src]
Add a set of Headers to the existing ones on this Request.
The headers will be merged in to any already set.
fn basic_auth<U, P>(
&mut self,
username: U,
password: Option<P>
) -> &mut RequestBuilder where
U: Into<String>,
P: Into<String>,
[src]
&mut self,
username: U,
password: Option<P>
) -> &mut RequestBuilder where
U: Into<String>,
P: Into<String>,
Enable HTTP basic authentication.
fn body<T: Into<Body>>(&mut self, body: T) -> &mut RequestBuilder
[src]
Set the request body.
fn query<T: Serialize + ?Sized>(&mut self, query: &T) -> &mut RequestBuilder
[src]
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&boo=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.
fn form<T: Serialize + ?Sized>(&mut self, form: &T) -> &mut RequestBuilder
[src]
Send a form body.
fn json<T: Serialize + ?Sized>(&mut self, json: &T) -> &mut RequestBuilder
[src]
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.
fn build(&mut self) -> Result<Request>
[src]
Build a Request
, which can be inspected, modified and executed with
Client::execute()
.
Panics
This method consumes builder internal state. It panics on an attempt to reuse already consumed builder.
fn send(&mut self) -> Pending
[src]
Constructs the Request and sends it the target URL, returning a Response.
Errors
This method fails if there was an error while sending request, redirect loop was detected or redirect limit was exhausted.