reqwest/blocking/
request.rs

1use std::convert::TryFrom;
2use std::fmt;
3use std::time::Duration;
4
5use http::{request::Parts, Request as HttpRequest, Version};
6#[cfg(any(feature = "query", feature = "form", feature = "json"))]
7use serde::Serialize;
8#[cfg(feature = "json")]
9use serde_json;
10
11use super::body::{self, Body};
12#[cfg(feature = "multipart")]
13use super::multipart;
14use super::Client;
15#[cfg(any(feature = "multipart", feature = "form", feature = "json"))]
16use crate::header::CONTENT_TYPE;
17use crate::header::{HeaderMap, HeaderName, HeaderValue};
18use crate::{async_impl, Method, Url};
19
20/// A request which can be executed with `Client::execute()`.
21pub struct Request {
22    body: Option<Body>,
23    inner: async_impl::Request,
24}
25
26/// A builder to construct the properties of a `Request`.
27///
28/// To construct a `RequestBuilder`, refer to the `Client` documentation.
29#[derive(Debug)]
30#[must_use = "RequestBuilder does nothing until you 'send' it"]
31pub struct RequestBuilder {
32    client: Client,
33    request: crate::Result<Request>,
34}
35
36impl Request {
37    /// Constructs a new request.
38    #[inline]
39    pub fn new(method: Method, url: Url) -> Self {
40        Request {
41            body: None,
42            inner: async_impl::Request::new(method, url),
43        }
44    }
45
46    /// Get the method.
47    #[inline]
48    pub fn method(&self) -> &Method {
49        self.inner.method()
50    }
51
52    /// Get a mutable reference to the method.
53    #[inline]
54    pub fn method_mut(&mut self) -> &mut Method {
55        self.inner.method_mut()
56    }
57
58    /// Get the url.
59    #[inline]
60    pub fn url(&self) -> &Url {
61        self.inner.url()
62    }
63
64    /// Get a mutable reference to the url.
65    #[inline]
66    pub fn url_mut(&mut self) -> &mut Url {
67        self.inner.url_mut()
68    }
69
70    /// Get the headers.
71    #[inline]
72    pub fn headers(&self) -> &HeaderMap {
73        self.inner.headers()
74    }
75
76    /// Get a mutable reference to the headers.
77    #[inline]
78    pub fn headers_mut(&mut self) -> &mut HeaderMap {
79        self.inner.headers_mut()
80    }
81
82    /// Get the http version.
83    #[inline]
84    pub fn version(&self) -> Version {
85        self.inner.version()
86    }
87
88    /// Get a mutable reference to the http version.
89    #[inline]
90    pub fn version_mut(&mut self) -> &mut Version {
91        self.inner.version_mut()
92    }
93
94    /// Get the body.
95    #[inline]
96    pub fn body(&self) -> Option<&Body> {
97        self.body.as_ref()
98    }
99
100    /// Get a mutable reference to the body.
101    #[inline]
102    pub fn body_mut(&mut self) -> &mut Option<Body> {
103        &mut self.body
104    }
105
106    /// Get the timeout.
107    #[inline]
108    pub fn timeout(&self) -> Option<&Duration> {
109        self.inner.timeout()
110    }
111
112    /// Get a mutable reference to the timeout.
113    #[inline]
114    pub fn timeout_mut(&mut self) -> &mut Option<Duration> {
115        self.inner.timeout_mut()
116    }
117
118    /// Attempts to clone the `Request`.
119    ///
120    /// None is returned if a body is which can not be cloned. This can be because the body is a
121    /// stream.
122    pub fn try_clone(&self) -> Option<Request> {
123        let body = if let Some(ref body) = self.body.as_ref() {
124            if let Some(body) = body.try_clone() {
125                Some(body)
126            } else {
127                return None;
128            }
129        } else {
130            None
131        };
132        let mut req = Request::new(self.method().clone(), self.url().clone());
133        *req.timeout_mut() = self.timeout().copied();
134        *req.headers_mut() = self.headers().clone();
135        *req.version_mut() = self.version().clone();
136        req.body = body;
137        Some(req)
138    }
139
140    pub(crate) fn into_async(self) -> (async_impl::Request, Option<body::Sender>) {
141        use crate::header::CONTENT_LENGTH;
142
143        let mut req_async = self.inner;
144        let body = self.body.and_then(|body| {
145            let (tx, body, len) = body.into_async();
146            if let Some(len) = len {
147                req_async.headers_mut().insert(CONTENT_LENGTH, len.into());
148            }
149            *req_async.body_mut() = Some(body);
150            tx
151        });
152        (req_async, body)
153    }
154}
155
156impl RequestBuilder {
157    pub(crate) fn new(client: Client, request: crate::Result<Request>) -> RequestBuilder {
158        let mut builder = RequestBuilder { client, request };
159
160        let auth = builder
161            .request
162            .as_mut()
163            .ok()
164            .and_then(|req| async_impl::request::extract_authority(req.url_mut()));
165
166        if let Some((username, password)) = auth {
167            builder.basic_auth(username, password)
168        } else {
169            builder
170        }
171    }
172
173    /// Assemble a builder starting from an existing `Client` and a `Request`.
174    pub fn from_parts(client: Client, request: Request) -> RequestBuilder {
175        RequestBuilder {
176            client,
177            request: crate::Result::Ok(request),
178        }
179    }
180
181    /// Add a `Header` to this Request.
182    ///
183    /// ```rust
184    /// use reqwest::header::USER_AGENT;
185    ///
186    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
187    /// let client = reqwest::blocking::Client::new();
188    /// let res = client.get("https://www.rust-lang.org")
189    ///     .header(USER_AGENT, "foo")
190    ///     .send()?;
191    /// # Ok(())
192    /// # }
193    /// ```
194    pub fn header<K, V>(self, key: K, value: V) -> RequestBuilder
195    where
196        HeaderName: TryFrom<K>,
197        HeaderValue: TryFrom<V>,
198        <HeaderName as TryFrom<K>>::Error: Into<http::Error>,
199        <HeaderValue as TryFrom<V>>::Error: Into<http::Error>,
200    {
201        self.header_sensitive(key, value, false)
202    }
203
204    /// Add a `Header` to this Request with ability to define if header_value is sensitive.
205    fn header_sensitive<K, V>(mut self, key: K, value: V, sensitive: bool) -> RequestBuilder
206    where
207        HeaderName: TryFrom<K>,
208        HeaderValue: TryFrom<V>,
209        <HeaderName as TryFrom<K>>::Error: Into<http::Error>,
210        <HeaderValue as TryFrom<V>>::Error: Into<http::Error>,
211    {
212        let mut error = None;
213        if let Ok(ref mut req) = self.request {
214            match <HeaderName as TryFrom<K>>::try_from(key) {
215                Ok(key) => match <HeaderValue as TryFrom<V>>::try_from(value) {
216                    Ok(mut value) => {
217                        // We want to potentially make an unsensitive header
218                        // to be sensitive, not the reverse. So, don't turn off
219                        // a previously sensitive header.
220                        if sensitive {
221                            value.set_sensitive(true);
222                        }
223                        req.headers_mut().append(key, value);
224                    }
225                    Err(e) => error = Some(crate::error::builder(e.into())),
226                },
227                Err(e) => error = Some(crate::error::builder(e.into())),
228            };
229        }
230        if let Some(err) = error {
231            self.request = Err(err);
232        }
233        self
234    }
235
236    /// Add a set of Headers to the existing ones on this Request.
237    ///
238    /// The headers will be merged in to any already set.
239    ///
240    /// ```rust
241    /// use reqwest::header::{HeaderMap, HeaderValue, USER_AGENT, CONTENT_TYPE};
242    /// # use std::fs;
243    ///
244    /// fn construct_headers() -> HeaderMap {
245    ///     let mut headers = HeaderMap::new();
246    ///     headers.insert(USER_AGENT, HeaderValue::from_static("reqwest"));
247    ///     headers.insert(CONTENT_TYPE, HeaderValue::from_static("image/png"));
248    ///     headers
249    /// }
250    ///
251    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
252    /// let file = fs::File::open("much_beauty.png")?;
253    /// let client = reqwest::blocking::Client::new();
254    /// let res = client.post("http://httpbin.org/post")
255    ///     .headers(construct_headers())
256    ///     .body(file)
257    ///     .send()?;
258    /// # Ok(())
259    /// # }
260    /// ```
261    pub fn headers(mut self, headers: crate::header::HeaderMap) -> RequestBuilder {
262        if let Ok(ref mut req) = self.request {
263            crate::util::replace_headers(req.headers_mut(), headers);
264        }
265        self
266    }
267
268    /// Enable HTTP basic authentication.
269    ///
270    /// ```rust
271    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
272    /// let client = reqwest::blocking::Client::new();
273    /// let resp = client.delete("http://httpbin.org/delete")
274    ///     .basic_auth("admin", Some("good password"))
275    ///     .send()?;
276    /// # Ok(())
277    /// # }
278    /// ```
279    pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> RequestBuilder
280    where
281        U: fmt::Display,
282        P: fmt::Display,
283    {
284        let header_value = crate::util::basic_auth(username, password);
285        self.header_sensitive(crate::header::AUTHORIZATION, header_value, true)
286    }
287
288    /// Enable HTTP bearer authentication.
289    ///
290    /// ```rust
291    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
292    /// let client = reqwest::blocking::Client::new();
293    /// let resp = client.delete("http://httpbin.org/delete")
294    ///     .bearer_auth("token")
295    ///     .send()?;
296    /// # Ok(())
297    /// # }
298    /// ```
299    pub fn bearer_auth<T>(self, token: T) -> RequestBuilder
300    where
301        T: fmt::Display,
302    {
303        let header_value = format!("Bearer {token}");
304        self.header_sensitive(crate::header::AUTHORIZATION, &*header_value, true)
305    }
306
307    /// Set the request body.
308    ///
309    /// # Examples
310    ///
311    /// Using a string:
312    ///
313    /// ```rust
314    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
315    /// let client = reqwest::blocking::Client::new();
316    /// let res = client.post("http://httpbin.org/post")
317    ///     .body("from a &str!")
318    ///     .send()?;
319    /// # Ok(())
320    /// # }
321    /// ```
322    ///
323    /// Using a `File`:
324    ///
325    /// ```rust
326    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
327    /// let file = std::fs::File::open("from_a_file.txt")?;
328    /// let client = reqwest::blocking::Client::new();
329    /// let res = client.post("http://httpbin.org/post")
330    ///     .body(file)
331    ///     .send()?;
332    /// # Ok(())
333    /// # }
334    /// ```
335    ///
336    /// Using arbitrary bytes:
337    ///
338    /// ```rust
339    /// # use std::fs;
340    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
341    /// // from bytes!
342    /// let bytes: Vec<u8> = vec![1, 10, 100];
343    /// let client = reqwest::blocking::Client::new();
344    /// let res = client.post("http://httpbin.org/post")
345    ///     .body(bytes)
346    ///     .send()?;
347    /// # Ok(())
348    /// # }
349    /// ```
350    pub fn body<T: Into<Body>>(mut self, body: T) -> RequestBuilder {
351        if let Ok(ref mut req) = self.request {
352            *req.body_mut() = Some(body.into());
353        }
354        self
355    }
356
357    /// Enables a request timeout.
358    ///
359    /// The timeout is applied from when the request starts connecting until the
360    /// response body has finished. It affects only this request and overrides
361    /// the timeout configured using `ClientBuilder::timeout()`.
362    pub fn timeout(mut self, timeout: Duration) -> RequestBuilder {
363        if let Ok(ref mut req) = self.request {
364            *req.timeout_mut() = Some(timeout);
365        }
366        self
367    }
368
369    /// Modify the query string of the URL.
370    ///
371    /// Modifies the URL of this request, adding the parameters provided.
372    /// This method appends and does not overwrite. This means that it can
373    /// be called multiple times and that existing query parameters are not
374    /// overwritten if the same key is used. The key will simply show up
375    /// twice in the query string.
376    /// Calling `.query(&[("foo", "a"), ("foo", "b")])` gives `"foo=a&foo=b"`.
377    ///
378    /// ```rust
379    /// # use reqwest::Error;
380    /// #
381    /// # fn run() -> Result<(), Error> {
382    /// let client = reqwest::blocking::Client::new();
383    /// let res = client.get("http://httpbin.org")
384    ///     .query(&[("lang", "rust")])
385    ///     .send()?;
386    /// # Ok(())
387    /// # }
388    /// ```
389    ///
390    /// # Note
391    /// This method does not support serializing a single key-value
392    /// pair. Instead of using `.query(("key", "val"))`, use a sequence, such
393    /// as `.query(&[("key", "val")])`. It's also possible to serialize structs
394    /// and maps into a key-value pair.
395    ///
396    /// # Optional
397    ///
398    /// This requires the optional `query` feature to be enabled.
399    ///
400    /// # Errors
401    /// This method will fail if the object you provide cannot be serialized
402    /// into a query string.
403    #[cfg(feature = "query")]
404    #[cfg_attr(docsrs, doc(cfg(feature = "query")))]
405    pub fn query<T: Serialize + ?Sized>(mut self, query: &T) -> RequestBuilder {
406        let mut error = None;
407        if let Ok(ref mut req) = self.request {
408            let url = req.url_mut();
409            let mut pairs = url.query_pairs_mut();
410            let serializer = serde_urlencoded::Serializer::new(&mut pairs);
411
412            if let Err(err) = query.serialize(serializer) {
413                error = Some(crate::error::builder(err));
414            }
415        }
416        if let Ok(ref mut req) = self.request {
417            if let Some("") = req.url().query() {
418                req.url_mut().set_query(None);
419            }
420        }
421        if let Some(err) = error {
422            self.request = Err(err);
423        }
424        self
425    }
426
427    /// Set HTTP version
428    pub fn version(mut self, version: Version) -> RequestBuilder {
429        if let Ok(ref mut req) = self.request {
430            *req.version_mut() = version;
431        }
432        self
433    }
434
435    /// Send a form body.
436    ///
437    /// Sets the body to the url encoded serialization of the passed value,
438    /// and also sets the `Content-Type: application/x-www-form-urlencoded`
439    /// header.
440    ///
441    /// ```rust
442    /// # use reqwest::Error;
443    /// # use std::collections::HashMap;
444    /// #
445    /// # fn run() -> Result<(), Error> {
446    /// let mut params = HashMap::new();
447    /// params.insert("lang", "rust");
448    ///
449    /// let client = reqwest::blocking::Client::new();
450    /// let res = client.post("http://httpbin.org")
451    ///     .form(&params)
452    ///     .send()?;
453    /// # Ok(())
454    /// # }
455    /// ```
456    ///
457    /// # Optional
458    ///
459    /// This requires the optional `form` feature to be enabled.
460    ///
461    /// # Errors
462    ///
463    /// This method fails if the passed value cannot be serialized into
464    /// url encoded format
465    #[cfg(feature = "form")]
466    #[cfg_attr(docsrs, doc(cfg(feature = "form")))]
467    pub fn form<T: Serialize + ?Sized>(mut self, form: &T) -> RequestBuilder {
468        let mut error = None;
469        if let Ok(ref mut req) = self.request {
470            match serde_urlencoded::to_string(form) {
471                Ok(body) => {
472                    req.headers_mut()
473                        .entry(CONTENT_TYPE)
474                        .or_insert(HeaderValue::from_static(
475                            "application/x-www-form-urlencoded",
476                        ));
477                    *req.body_mut() = Some(body.into());
478                }
479                Err(err) => error = Some(crate::error::builder(err)),
480            }
481        }
482        if let Some(err) = error {
483            self.request = Err(err);
484        }
485        self
486    }
487
488    /// Send a JSON body.
489    ///
490    /// Sets the body to the JSON serialization of the passed value, and
491    /// also sets the `Content-Type: application/json` header.
492    ///
493    /// # Optional
494    ///
495    /// This requires the optional `json` feature enabled.
496    ///
497    /// # Examples
498    ///
499    /// ```rust
500    /// # use reqwest::Error;
501    /// # use std::collections::HashMap;
502    /// #
503    /// # fn run() -> Result<(), Error> {
504    /// let mut map = HashMap::new();
505    /// map.insert("lang", "rust");
506    ///
507    /// let client = reqwest::blocking::Client::new();
508    /// let res = client.post("http://httpbin.org")
509    ///     .json(&map)
510    ///     .send()?;
511    /// # Ok(())
512    /// # }
513    /// ```
514    ///
515    /// # Errors
516    ///
517    /// Serialization can fail if `T`'s implementation of `Serialize` decides to
518    /// fail, or if `T` contains a map with non-string keys.
519    #[cfg(feature = "json")]
520    #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
521    pub fn json<T: Serialize + ?Sized>(mut self, json: &T) -> RequestBuilder {
522        let mut error = None;
523        if let Ok(ref mut req) = self.request {
524            match serde_json::to_vec(json) {
525                Ok(body) => {
526                    req.headers_mut()
527                        .entry(CONTENT_TYPE)
528                        .or_insert_with(|| HeaderValue::from_static("application/json"));
529                    *req.body_mut() = Some(body.into());
530                }
531                Err(err) => error = Some(crate::error::builder(err)),
532            }
533        }
534        if let Some(err) = error {
535            self.request = Err(err);
536        }
537        self
538    }
539
540    /// Sends a multipart/form-data body.
541    ///
542    /// ```
543    /// # use reqwest::Error;
544    ///
545    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
546    /// let client = reqwest::blocking::Client::new();
547    /// let form = reqwest::blocking::multipart::Form::new()
548    ///     .text("key3", "value3")
549    ///     .file("file", "/path/to/field")?;
550    ///
551    /// let response = client.post("your url")
552    ///     .multipart(form)
553    ///     .send()?;
554    /// # Ok(())
555    /// # }
556    /// ```
557    ///
558    /// See [`multipart`](multipart/) for more examples.
559    #[cfg(feature = "multipart")]
560    #[cfg_attr(docsrs, doc(cfg(feature = "multipart")))]
561    pub fn multipart(self, mut multipart: multipart::Form) -> RequestBuilder {
562        let mut builder = self.header(
563            CONTENT_TYPE,
564            format!("multipart/form-data; boundary={}", multipart.boundary()).as_str(),
565        );
566        if let Ok(ref mut req) = builder.request {
567            *req.body_mut() = Some(match multipart.compute_length() {
568                Some(length) => Body::sized(multipart.reader(), length),
569                None => Body::new(multipart.reader()),
570            })
571        }
572        builder
573    }
574
575    /// Build a `Request`, which can be inspected, modified and executed with
576    /// `Client::execute()`.
577    pub fn build(self) -> crate::Result<Request> {
578        self.request
579    }
580
581    /// Build a `Request`, which can be inspected, modified and executed with
582    /// `Client::execute()`.
583    ///
584    /// This is similar to [`RequestBuilder::build()`], but also returns the
585    /// embedded `Client`.
586    pub fn build_split(self) -> (Client, crate::Result<Request>) {
587        (self.client, self.request)
588    }
589
590    /// Constructs the Request and sends it the target URL, returning a Response.
591    ///
592    /// # Errors
593    ///
594    /// This method fails if there was an error while sending request,
595    /// redirect loop was detected or redirect limit was exhausted.
596    pub fn send(self) -> crate::Result<super::Response> {
597        self.client.execute(self.request?)
598    }
599
600    /// Attempts to clone the `RequestBuilder`.
601    ///
602    /// None is returned if a body is which can not be cloned. This can be because the body is a
603    /// stream.
604    ///
605    /// # Examples
606    ///
607    /// With a static body
608    ///
609    /// ```rust
610    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
611    /// let client = reqwest::blocking::Client::new();
612    /// let builder = client.post("http://httpbin.org/post")
613    ///     .body("from a &str!");
614    /// let clone = builder.try_clone();
615    /// assert!(clone.is_some());
616    /// # Ok(())
617    /// # }
618    /// ```
619    ///
620    /// Without a body
621    ///
622    /// ```rust
623    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
624    /// let client = reqwest::blocking::Client::new();
625    /// let builder = client.get("http://httpbin.org/get");
626    /// let clone = builder.try_clone();
627    /// assert!(clone.is_some());
628    /// # Ok(())
629    /// # }
630    /// ```
631    ///
632    /// With a non-cloneable body
633    ///
634    /// ```rust
635    /// # fn run() -> Result<(), Box<dyn std::error::Error>> {
636    /// let client = reqwest::blocking::Client::new();
637    /// let builder = client.get("http://httpbin.org/get")
638    ///     .body(reqwest::blocking::Body::new(std::io::empty()));
639    /// let clone = builder.try_clone();
640    /// assert!(clone.is_none());
641    /// # Ok(())
642    /// # }
643    /// ```
644    pub fn try_clone(&self) -> Option<RequestBuilder> {
645        self.request
646            .as_ref()
647            .ok()
648            .and_then(|req| req.try_clone())
649            .map(|req| RequestBuilder {
650                client: self.client.clone(),
651                request: Ok(req),
652            })
653    }
654}
655
656impl<T> TryFrom<HttpRequest<T>> for Request
657where
658    T: Into<Body>,
659{
660    type Error = crate::Error;
661
662    fn try_from(req: HttpRequest<T>) -> crate::Result<Self> {
663        let (parts, body) = req.into_parts();
664        let Parts {
665            method,
666            uri,
667            headers,
668            ..
669        } = parts;
670        let url = Url::parse(&uri.to_string()).map_err(crate::error::builder)?;
671        let mut inner = async_impl::Request::new(method, url);
672        crate::util::replace_headers(inner.headers_mut(), headers);
673        Ok(Request {
674            body: Some(body.into()),
675            inner,
676        })
677    }
678}
679
680impl fmt::Debug for Request {
681    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
682        fmt_request_fields(&mut f.debug_struct("Request"), self).finish()
683    }
684}
685
686fn fmt_request_fields<'a, 'b>(
687    f: &'a mut fmt::DebugStruct<'a, 'b>,
688    req: &Request,
689) -> &'a mut fmt::DebugStruct<'a, 'b> {
690    f.field("method", req.method())
691        .field("url", req.url())
692        .field("headers", req.headers())
693}
694
695#[cfg(test)]
696mod tests {
697    use super::*;
698    use crate::header::{ACCEPT, HOST};
699    #[cfg(feature = "query")]
700    use std::collections::BTreeMap;
701    #[cfg(feature = "form")]
702    use std::collections::HashMap;
703
704    #[test]
705    fn basic_get_request() {
706        let client = Client::new();
707        let some_url = "https://google.com/";
708        let r = client.get(some_url).build().unwrap();
709
710        assert_eq!(r.method(), &Method::GET);
711        assert_eq!(r.url().as_str(), some_url);
712    }
713
714    #[test]
715    fn basic_head_request() {
716        let client = Client::new();
717        let some_url = "https://google.com/";
718        let r = client.head(some_url).build().unwrap();
719
720        assert_eq!(r.method(), &Method::HEAD);
721        assert_eq!(r.url().as_str(), some_url);
722    }
723
724    #[test]
725    fn basic_post_request() {
726        let client = Client::new();
727        let some_url = "https://google.com/";
728        let r = client.post(some_url).build().unwrap();
729
730        assert_eq!(r.method(), &Method::POST);
731        assert_eq!(r.url().as_str(), some_url);
732    }
733
734    #[test]
735    fn basic_put_request() {
736        let client = Client::new();
737        let some_url = "https://google.com/";
738        let r = client.put(some_url).build().unwrap();
739
740        assert_eq!(r.method(), &Method::PUT);
741        assert_eq!(r.url().as_str(), some_url);
742    }
743
744    #[test]
745    fn basic_patch_request() {
746        let client = Client::new();
747        let some_url = "https://google.com/";
748        let r = client.patch(some_url).build().unwrap();
749
750        assert_eq!(r.method(), &Method::PATCH);
751        assert_eq!(r.url().as_str(), some_url);
752    }
753
754    #[test]
755    fn basic_delete_request() {
756        let client = Client::new();
757        let some_url = "https://google.com/";
758        let r = client.delete(some_url).build().unwrap();
759
760        assert_eq!(r.method(), &Method::DELETE);
761        assert_eq!(r.url().as_str(), some_url);
762    }
763
764    #[test]
765    fn add_header() {
766        let client = Client::new();
767        let some_url = "https://google.com/";
768        let r = client.post(some_url);
769
770        let header = HeaderValue::from_static("google.com");
771
772        // Add a copy of the header to the request builder
773        let r = r.header(HOST, header.clone()).build().unwrap();
774
775        // then check it was actually added
776        assert_eq!(r.headers().get(HOST), Some(&header));
777    }
778
779    #[test]
780    fn add_headers() {
781        let client = Client::new();
782        let some_url = "https://google.com/";
783        let r = client.post(some_url);
784
785        let header = HeaderValue::from_static("google.com");
786
787        let mut headers = HeaderMap::new();
788        headers.insert(HOST, header);
789
790        // Add a copy of the headers to the request builder
791        let r = r.headers(headers.clone()).build().unwrap();
792
793        // then make sure they were added correctly
794        assert_eq!(r.headers(), &headers);
795    }
796
797    #[test]
798    fn add_headers_multi() {
799        let client = Client::new();
800        let some_url = "https://google.com/";
801        let r = client.post(some_url);
802
803        let header_json = HeaderValue::from_static("application/json");
804        let header_xml = HeaderValue::from_static("application/xml");
805
806        let mut headers = HeaderMap::new();
807        headers.append(ACCEPT, header_json);
808        headers.append(ACCEPT, header_xml);
809
810        // Add a copy of the headers to the request builder
811        let r = r.headers(headers.clone()).build().unwrap();
812
813        // then make sure they were added correctly
814        assert_eq!(r.headers(), &headers);
815        let mut all_values = r.headers().get_all(ACCEPT).iter();
816        assert_eq!(all_values.next().unwrap(), &"application/json");
817        assert_eq!(all_values.next().unwrap(), &"application/xml");
818        assert_eq!(all_values.next(), None);
819    }
820
821    #[test]
822    fn add_body() {
823        let client = Client::new();
824        let some_url = "https://google.com/";
825        let r = client.post(some_url);
826
827        let body = "Some interesting content";
828
829        let mut r = r.body(body).build().unwrap();
830
831        let buf = body::read_to_string(r.body_mut().take().unwrap()).unwrap();
832
833        assert_eq!(buf, body);
834    }
835
836    #[test]
837    #[cfg(feature = "query")]
838    fn add_query_append() {
839        let client = Client::new();
840        let some_url = "https://google.com/";
841        let mut r = client.get(some_url);
842
843        r = r.query(&[("foo", "bar")]);
844        r = r.query(&[("qux", 3)]);
845
846        let req = r.build().expect("request is valid");
847        assert_eq!(req.url().query(), Some("foo=bar&qux=3"));
848    }
849
850    #[test]
851    #[cfg(feature = "query")]
852    fn add_query_append_same() {
853        let client = Client::new();
854        let some_url = "https://google.com/";
855        let mut r = client.get(some_url);
856
857        r = r.query(&[("foo", "a"), ("foo", "b")]);
858
859        let req = r.build().expect("request is valid");
860        assert_eq!(req.url().query(), Some("foo=a&foo=b"));
861    }
862
863    #[test]
864    #[cfg(feature = "query")]
865    fn add_query_struct() {
866        #[derive(Serialize)]
867        struct Params {
868            foo: String,
869            qux: i32,
870        }
871
872        let client = Client::new();
873        let some_url = "https://google.com/";
874        let mut r = client.get(some_url);
875
876        let params = Params {
877            foo: "bar".into(),
878            qux: 3,
879        };
880
881        r = r.query(&params);
882
883        let req = r.build().expect("request is valid");
884        assert_eq!(req.url().query(), Some("foo=bar&qux=3"));
885    }
886
887    #[test]
888    #[cfg(feature = "query")]
889    fn add_query_map() {
890        let mut params = BTreeMap::new();
891        params.insert("foo", "bar");
892        params.insert("qux", "three");
893
894        let client = Client::new();
895        let some_url = "https://google.com/";
896        let mut r = client.get(some_url);
897
898        r = r.query(&params);
899
900        let req = r.build().expect("request is valid");
901        assert_eq!(req.url().query(), Some("foo=bar&qux=three"));
902    }
903
904    #[test]
905    #[cfg(feature = "form")]
906    fn add_form() {
907        let client = Client::new();
908        let some_url = "https://google.com/";
909        let r = client.post(some_url);
910
911        let mut form_data = HashMap::new();
912        form_data.insert("foo", "bar");
913
914        let mut r = r.form(&form_data).build().unwrap();
915
916        // Make sure the content type was set
917        assert_eq!(
918            r.headers().get(CONTENT_TYPE).unwrap(),
919            &"application/x-www-form-urlencoded"
920        );
921
922        let buf = body::read_to_string(r.body_mut().take().unwrap()).unwrap();
923
924        let body_should_be = serde_urlencoded::to_string(&form_data).unwrap();
925        assert_eq!(buf, body_should_be);
926    }
927
928    #[test]
929    #[cfg(feature = "json")]
930    fn add_json() {
931        let client = Client::new();
932        let some_url = "https://google.com/";
933        let r = client.post(some_url);
934
935        let mut json_data = HashMap::new();
936        json_data.insert("foo", "bar");
937
938        let mut r = r.json(&json_data).build().unwrap();
939
940        // Make sure the content type was set
941        assert_eq!(r.headers().get(CONTENT_TYPE).unwrap(), &"application/json");
942
943        let buf = body::read_to_string(r.body_mut().take().unwrap()).unwrap();
944
945        let body_should_be = serde_json::to_string(&json_data).unwrap();
946        assert_eq!(buf, body_should_be);
947    }
948
949    #[test]
950    #[cfg(feature = "json")]
951    fn add_json_fail() {
952        use serde::ser::Error as _;
953        use serde::{Serialize, Serializer};
954        use std::error::Error as _;
955        struct MyStruct;
956        impl Serialize for MyStruct {
957            fn serialize<S>(&self, _serializer: S) -> Result<S::Ok, S::Error>
958            where
959                S: Serializer,
960            {
961                Err(S::Error::custom("nope"))
962            }
963        }
964
965        let client = Client::new();
966        let some_url = "https://google.com/";
967        let r = client.post(some_url);
968        let json_data = MyStruct;
969        let err = r.json(&json_data).build().unwrap_err();
970        assert!(err.is_builder()); // well, duh ;)
971        assert!(err.source().unwrap().is::<serde_json::Error>());
972    }
973
974    #[test]
975    fn test_replace_headers() {
976        use http::HeaderMap;
977
978        let mut headers = HeaderMap::new();
979        headers.insert("foo", "bar".parse().unwrap());
980        headers.append("foo", "baz".parse().unwrap());
981
982        let client = Client::new();
983        let req = client
984            .get("https://hyper.rs")
985            .header("im-a", "keeper")
986            .header("foo", "pop me")
987            .headers(headers)
988            .build()
989            .expect("request build");
990
991        assert_eq!(req.headers()["im-a"], "keeper");
992
993        let foo = req.headers().get_all("foo").iter().collect::<Vec<_>>();
994        assert_eq!(foo.len(), 2);
995        assert_eq!(foo[0], "bar");
996        assert_eq!(foo[1], "baz");
997    }
998
999    #[test]
1000    #[cfg(feature = "query")]
1001    fn normalize_empty_query() {
1002        let client = Client::new();
1003        let some_url = "https://google.com/";
1004        let empty_query: &[(&str, &str)] = &[];
1005
1006        let req = client
1007            .get(some_url)
1008            .query(empty_query)
1009            .build()
1010            .expect("request build");
1011
1012        assert_eq!(req.url().query(), None);
1013        assert_eq!(req.url().as_str(), "https://google.com/");
1014    }
1015
1016    #[test]
1017    fn convert_url_authority_into_basic_auth() {
1018        let client = Client::new();
1019        let some_url = "https://Aladdin:open sesame@localhost/";
1020
1021        let req = client.get(some_url).build().expect("request build");
1022
1023        assert_eq!(req.url().as_str(), "https://localhost/");
1024        assert_eq!(
1025            req.headers()["authorization"],
1026            "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
1027        );
1028    }
1029
1030    #[test]
1031    fn convert_from_http_request() {
1032        let http_request = HttpRequest::builder()
1033            .method("GET")
1034            .uri("http://localhost/")
1035            .header("User-Agent", "my-awesome-agent/1.0")
1036            .body("test test test")
1037            .unwrap();
1038        let req: Request = Request::try_from(http_request).unwrap();
1039        assert_eq!(req.body().is_none(), false);
1040        let test_data = b"test test test";
1041        assert_eq!(req.body().unwrap().as_bytes(), Some(&test_data[..]));
1042        let headers = req.headers();
1043        assert_eq!(headers.get("User-Agent").unwrap(), "my-awesome-agent/1.0");
1044        assert_eq!(req.method(), Method::GET);
1045        assert_eq!(req.url().as_str(), "http://localhost/");
1046    }
1047
1048    #[test]
1049    fn set_http_request_version() {
1050        let http_request = HttpRequest::builder()
1051            .method("GET")
1052            .uri("http://localhost/")
1053            .header("User-Agent", "my-awesome-agent/1.0")
1054            .version(Version::HTTP_11)
1055            .body("test test test")
1056            .unwrap();
1057        let req: Request = Request::try_from(http_request).unwrap();
1058        assert_eq!(req.body().is_none(), false);
1059        let test_data = b"test test test";
1060        assert_eq!(req.body().unwrap().as_bytes(), Some(&test_data[..]));
1061        let headers = req.headers();
1062        assert_eq!(headers.get("User-Agent").unwrap(), "my-awesome-agent/1.0");
1063        assert_eq!(req.method(), Method::GET);
1064        assert_eq!(req.url().as_str(), "http://localhost/");
1065        assert_eq!(req.version(), Version::HTTP_11);
1066    }
1067
1068    #[test]
1069    fn test_basic_auth_sensitive_header() {
1070        let client = Client::new();
1071        let some_url = "https://localhost/";
1072
1073        let req = client
1074            .get(some_url)
1075            .basic_auth("Aladdin", Some("open sesame"))
1076            .build()
1077            .expect("request build");
1078
1079        assert_eq!(req.url().as_str(), "https://localhost/");
1080        assert_eq!(
1081            req.headers()["authorization"],
1082            "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
1083        );
1084        assert_eq!(req.headers()["authorization"].is_sensitive(), true);
1085    }
1086
1087    #[test]
1088    fn test_bearer_auth_sensitive_header() {
1089        let client = Client::new();
1090        let some_url = "https://localhost/";
1091
1092        let req = client
1093            .get(some_url)
1094            .bearer_auth("Hold my bear")
1095            .build()
1096            .expect("request build");
1097
1098        assert_eq!(req.url().as_str(), "https://localhost/");
1099        assert_eq!(req.headers()["authorization"], "Bearer Hold my bear");
1100        assert_eq!(req.headers()["authorization"].is_sensitive(), true);
1101    }
1102
1103    #[test]
1104    fn test_request_cloning() {
1105        let mut request = Request::new(Method::GET, "https://example.com".try_into().unwrap());
1106        *request.timeout_mut() = Some(Duration::from_secs(42));
1107        *request.version_mut() = Version::HTTP_11;
1108
1109        let clone = request.try_clone().unwrap();
1110        assert_eq!(request.version(), clone.version());
1111        assert_eq!(request.headers(), clone.headers());
1112        assert_eq!(request.timeout(), clone.timeout());
1113    }
1114}
reqwest/blocking/request.rs

reqwest/blocking/
request.rs
