Struct RequestBuilder

Source

pub struct RequestBuilder { /* private fields */ }

Expand description

This is a wrapper around reqwest::RequestBuilder exposing the same API.

Implementations§

Source §

impl RequestBuilder

Source

pub fn from_parts( client: ClientWithMiddleware, request: Request, ) -> RequestBuilder

Assemble a builder starting from an existing Client and a Request.

Add a Header to this Request.

Source

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

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

The headers will be merged in to any already set.

Source

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

Source

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

Enable HTTP basic authentication.


let client = reqwest_middleware::ClientWithMiddleware::from(reqwest::Client::new());
let resp = client.delete("http://httpbin.org/delete")
    .basic_auth("admin", Some("good password"))
    .send()
    .await?;

Source

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

Enable HTTP bearer authentication.

Source

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

Set the request body.

Source

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

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().

Source

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

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

Source

pub fn build_split(self) -> (ClientWithMiddleware, Result<Request>)

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

This is similar to RequestBuilder::build(), but also returns the embedded Client.

Source

pub fn with_extension<T: Send + Sync + Clone + 'static>( self, extension: T, ) -> Self

Inserts the extension into this request builder

Source

pub fn extensions(&mut self) -> &mut Extensions

Returns a mutable reference to the internal set of extensions for this request

Source

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

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_middleware::ClientWithMiddleware::from(reqwest::Client::new())
    .get("https://hyper.rs")
    .send()
    .await?;

Source

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

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_middleware::ClientWithMiddleware::from(reqwest::Client::new());
let builder = client.post("http://httpbin.org/post")
    .body("from a &str!");
let clone = builder.try_clone();
assert!(clone.is_some());