Struct RequestBuilder 

pub struct RequestBuilder { /* private fields */ }

Builds a request, with the methods of reqwest’s RequestBuilder that generated clients use.

An error in any step (an invalid URL, header or body) is kept and returned by RequestBuilder::build.

Implementations

impl RequestBuilder

pub fn header<K, V>(self, name: K, value: V) -> Self

where HeaderName: TryFrom<K>, <HeaderName as TryFrom<K>>::Error: Into<Error>, HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<Error>,

Adds a header.

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

Adds every header of a map.

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

Appends query parameters, serialized as application/x-www-form-urlencoded: a sequence of pairs, a map or a struct.

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

Sets an Authorization: Bearer header.

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

Sets an Authorization: Basic header.

pub fn sensitive_header<K, V>(self, name: K, value: V) -> Self

where HeaderName: TryFrom<K>, <HeaderName as TryFrom<K>>::Error: Into<Error>, HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<Error>,

Sets a header, replacing any earlier value, and marks it sensitive (see HeaderValue::set_sensitive): for credentials such as an API key.

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

Sets the body: bytes, a Body, or an Upload (a file, say, streamed and sent again by a retry).

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

Sets a JSON body, and Content-Type: application/json unless a content type is set.

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

Sets a form body (application/x-www-form-urlencoded).

pub fn multipart(self, form: Form) -> Self

Sets a multipart/form-data body, with a Content-Length when the length of every part is known.

pub fn base(self, base_url: &str) -> Self

Declares the base URL the request’s URL was built on: a generated client’s Configuration.base_path. A RequestOptions::base_url replaces it. A base the URL is not under is ignored.

pub fn options(self, options: &RequestOptions) -> Self

Applies RequestOptions: each of its headers replaces every value the request has under that name (call it last to override what was set before, as generated clients do), its query parameters are appended, and its base URL replaces the request’s base, keeping the rest of the path and the query. A ProviderLayer leaves what the options set alone.

pub fn build(self) -> Result<Request<Body>, Error>

The request, or the first error of the steps that built it.

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

Builds the request and sends it with the client that started it.

Trait Implementations

impl Debug for RequestBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.