Struct reqwest::RequestBuilder[−][src]

pub struct RequestBuilder { /* fields omitted */ }

A builder to construct the properties of a Request.

Implementations

impl RequestBuilder[src]

pub fn query<T: Serialize + ?Sized>(self, query: &T) -> 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&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.

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

Send a form body.

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

This is supported on crate feature json only.

Set the request json

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

Enable HTTP bearer authentication.

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

Set the request body.

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

This is supported on crate feature multipart only.

TODO

pub fn header<K, V>(self, key: K, value: V) -> RequestBuilder where
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>,
    HeaderValue: TryFrom<V>,
    <HeaderValue as TryFrom<V>>::Error: Into<Error>, [src]

Add a Header to this Request.

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

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

The headers will be merged in to any already set.

pub fn fetch_mode_no_cors(self) -> RequestBuilder[src]

Disable CORS on fetching the request.

WASM

This option is only effective with WebAssembly target.

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

pub fn build(self) -> Result<Request>[src]

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

pub async fn send(self) -> Result<Response>[src]

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.

Example

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

Trait Implementations

impl Debug for RequestBuilder[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.