Struct reqwest::RequestBuilder
source · [−]pub struct RequestBuilder { /* private fields */ }
Expand description
A builder to construct the properties of a Request
.
To construct a RequestBuilder
, refer to the Client
documentation.
Implementations
sourceimpl RequestBuilder
impl RequestBuilder
sourcepub 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>,
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>,
Add a Header
to this Request.
sourcepub fn headers(self, headers: HeaderMap) -> RequestBuilder
pub fn headers(self, headers: HeaderMap) -> RequestBuilder
Add a set of Headers to the existing ones on this Request.
The headers will be merged in to any already set.
sourcepub fn basic_auth<U, P>(
self,
username: U,
password: Option<P>
) -> RequestBuilder where
U: Display,
P: Display,
pub fn basic_auth<U, P>(
self,
username: U,
password: Option<P>
) -> RequestBuilder where
U: Display,
P: Display,
Enable HTTP basic authentication.
sourcepub fn bearer_auth<T>(self, token: T) -> RequestBuilder where
T: Display,
pub fn bearer_auth<T>(self, token: T) -> RequestBuilder where
T: Display,
Enable HTTP bearer authentication.
sourcepub fn body<T: Into<Body>>(self, body: T) -> RequestBuilder
pub fn body<T: Into<Body>>(self, body: T) -> RequestBuilder
Set the request body.
sourcepub fn timeout(self, timeout: Duration) -> RequestBuilder
pub fn timeout(self, timeout: Duration) -> RequestBuilder
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()
.
sourcepub fn multipart(self, multipart: Form) -> RequestBuilder
pub fn multipart(self, multipart: Form) -> RequestBuilder
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?;
sourcepub fn query<T: Serialize + ?Sized>(self, query: &T) -> RequestBuilder
pub fn query<T: Serialize + ?Sized>(self, query: &T) -> RequestBuilder
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.
sourcepub fn version(self, version: Version) -> RequestBuilder
pub fn version(self, version: Version) -> RequestBuilder
Set HTTP version
sourcepub fn fetch_mode_no_cors(self) -> RequestBuilder
pub fn fetch_mode_no_cors(self) -> RequestBuilder
Disable CORS on fetching the request.
WASM
This option is only effective with WebAssembly target.
The request mode will be set to ‘no-cors’.
sourcepub fn build(self) -> Result<Request>
pub fn build(self) -> Result<Request>
Build a Request
, which can be inspected, modified and executed with
Client::execute()
.
sourcepub fn send(self) -> impl Future<Output = Result<Response, Error>>
pub fn send(self) -> impl Future<Output = Result<Response, Error>>
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?;
sourcepub fn try_clone(&self) -> Option<RequestBuilder>
pub fn try_clone(&self) -> Option<RequestBuilder>
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());
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for RequestBuilder
impl Send for RequestBuilder
impl Sync for RequestBuilder
impl Unpin for RequestBuilder
impl !UnwindSafe for RequestBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more