reqwest/async_impl/
request.rs

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

reqwest/async_impl/
request.rs
