Struct reqwest::RequestBuilder[−][src]

pub struct RequestBuilder { /* fields omitted */ }

Expand description

A builder to construct the properties of a Request.

To construct a RequestBuilder, refer to the Client documentation.

Implementations

[src]

impl RequestBuilder

This is supported on non-WebAssembly only.

Add a Header to this Request.

[src]

pub fn headers(self, headers: HeaderMap) -> RequestBuilder

This is supported on non-WebAssembly only.

Add a set of Headers to the existing ones on this Request.

The headers will be merged in to any already set.

[src]

pub fn basic_auth<U, P>(
 self,
 username: U,
 password: Option
) -> RequestBuilder where
 U: Display,
 P: Display,

This is supported on non-WebAssembly only.

Enable HTTP basic authentication.

[src]

pub fn bearer_auth<T>(self, token: T) -> RequestBuilder where
T: Display,

This is supported on non-WebAssembly only.

Enable HTTP bearer authentication.

[src]

pub fn body<T: Into<Body>>(self, body: T) -> RequestBuilder

This is supported on non-WebAssembly only.

Set the request body.

[src]

pub fn timeout(self, timeout: Duration) -> RequestBuilder

This is supported on non-WebAssembly only.

Enables a request timeout.

The timeout is applied from when the request starts connecting until the response body has finished. It affects only this request and overrides the timeout configured using ClientBuilder::timeout().

[src]

pub fn multipart(self, multipart: Form) -> RequestBuilder

This is supported on non-WebAssembly and crate feature multipart only.

Sends a multipart/form-data body.


let client = reqwest::Client::new();
let form = reqwest::multipart::Form::new()
    .text("key3", "value3")
    .text("key4", "value4");


let response = client.post("your url")
    .multipart(form)
    .send()
    .await?;

[src]

pub fn query<T: Serialize + ?Sized>(self, query: &T) -> RequestBuilder

This is supported on non-WebAssembly only.

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.

[src]

pub fn version(self, version: Version) -> RequestBuilder

This is supported on non-WebAssembly only.

Set HTTP version

[src]

pub fn form<T: Serialize + ?Sized>(self, form: &T) -> RequestBuilder

This is supported on non-WebAssembly only.

Send a form body.

[src]

pub fn json<T: Serialize + ?Sized>(self, json: &T) -> RequestBuilder

This is supported on non-WebAssembly and crate feature json only.

Send a JSON body.

Optional

This requires the optional json feature enabled.

Errors

Serialization can fail if T’s implementation of Serialize decides to fail, or if T contains a map with non-string keys.

[src]

pub fn fetch_mode_no_cors(self) -> RequestBuilder

This is supported on non-WebAssembly only.

Disable CORS on fetching the request.

WASM

This option is only effective with WebAssembly target.

The request mode will be set to ‘no-cors’.

[src]

pub fn build(self) -> Result<Request>

This is supported on non-WebAssembly only.

Build a Request, which can be inspected, modified and executed with Client::execute().

[src]

pub fn send(self) -> impl Future<Output = Result<Response, Error>>

This is supported on non-WebAssembly only.

Constructs the Request and sends it to the target URL, returning a future Response.

Errors

This method fails if there was an error while sending request, redirect loop was detected or redirect limit was exhausted.

Example

let response = reqwest::Client::new()
    .get("https://hyper.rs")
    .send()
    .await?;

[src]

pub fn try_clone(&self) -> Option<RequestBuilder>

This is supported on non-WebAssembly only.

Attempt to clone the RequestBuilder.

None is returned if the RequestBuilder can not be cloned, i.e. if the request body is a stream.

Examples

let client = reqwest::Client::new();
let builder = client.post("http://httpbin.org/post")
    .body("from a &str!");
let clone = builder.try_clone();
assert!(clone.is_some());