reqwest/async_impl/
request.rs

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

reqwest/async_impl/
request.rs
