async/request: add a basic example for send()

jishida · Feb 15, 2019 · 0c84e6b · 0c84e6b
1 parent 8b62f47
commit 0c84e6b
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/src/async_impl/request.rs b/src/async_impl/request.rs
@@ -324,6 +324,26 @@ impl RequestBuilder {
     ///
     /// This method fails if there was an error while sending request,
     /// redirect loop was detected or redirect limit was exhausted.
+    ///
+    /// # Example
+    ///
+    /// ```no_run
+    /// # extern crate futures;
+    /// # extern crate reqwest;
+    /// #
+    /// # use reqwest::Error;
+    /// # use futures::future::Future;
+    /// #
+    /// # fn run() -> Result<(), Error> {
+    /// let response = reqwest::r#async::Client::new()
+    ///     .get("https://hyper.rs")
+    ///     .send()
+    ///     .map(|resp| println!("status: {}", resp.status()));
+    ///
+    /// let mut rt = tokio::runtime::current_thread::Runtime::new().expect("new rt");
+    /// rt.block_on(response)
+    /// # }
+    /// ```
     pub fn send(self) -> impl Future<Item = Response, Error = ::Error> {
         match self.request {
             Ok(req) => self.client.execute(req),