Merge pull request #820 from Fishrock123/request-deserialize-query-borrowed

Request: allow Deserialize<'de> for .query()

Author: Fishrock123

Cargo.toml

@@ -41,7 +41,7 @@ async-trait = "0.1.41"
 femme = { version = "2.1.1", optional = true }
 futures-util = "0.3.6"
 http-client = { version = "6.1.0", default-features = false }
-http-types = { version = "2.10.0", default-features = false, features = ["fs"] }
+http-types = { version = "2.11.0", default-features = false, features = ["fs"] }
 kv-log-macro = "1.0.7"
 log = { version = "0.4.13", features = ["kv_unstable_std"] }
 pin-project-lite = "0.2.0"

src/request.rs

@@ -302,54 +302,41 @@ impl<State> Request<State> {
     }
 
     /// Parse the URL query component into a struct, using [serde_qs](https://docs.rs/serde_qs). To
-    /// get the entire query as an unparsed string, use `request.url().query()`
+    /// get the entire query as an unparsed string, use `request.url().query()`.
     ///
-    /// ```rust
-    /// # fn main() -> Result<(), std::io::Error> { async_std::task::block_on(async {
-    /// use tide::prelude::*;
-    /// let mut app = tide::new();
+    /// # Examples
     ///
-    /// #[derive(Deserialize)]
-    /// #[serde(default)]
-    /// struct Page {
-    ///     size: u8,
-    ///     offset: u8,
-    /// }
-    /// impl Default for Page {
-    ///     fn default() -> Self {
-    ///         Self {
-    ///             size: 25,
-    ///             offset: 0,
-    ///         }
-    ///     }
-    /// }
-    /// app.at("/pages").post(|req: tide::Request<()>| async move {
-    ///     let page: Page = req.query()?;
-    ///     Ok(format!("page {}, with {} items", page.offset, page.size))
-    /// });
+    /// ```
+    /// use std::collections::HashMap;
+    /// use tide::http::{self, convert::Deserialize};
+    /// use tide::Request;
     ///
-    /// # if false {
-    /// app.listen("localhost:8000").await?;
-    /// # }
+    /// // An owned structure:
     ///
-    /// // $ curl localhost:8000/pages
-    /// // page 0, with 25 items
+    /// #[derive(Deserialize)]
+    /// struct Index {
+    ///     page: u32,
+    ///     selections: HashMap<String, String>,
+    /// }
     ///
-    /// // $ curl localhost:8000/pages?offset=1
-    /// // page 1, with 25 items
+    /// let req: Request<()> = http::Request::get("https://httpbin.org/get?page=2&selections[width]=narrow&selections[height]=tall").into();
+    /// let Index { page, selections } = req.query().unwrap();
+    /// assert_eq!(page, 2);
+    /// assert_eq!(selections["width"], "narrow");
+    /// assert_eq!(selections["height"], "tall");
     ///
-    /// // $ curl localhost:8000/pages?offset=2&size=50
-    /// // page 2, with 50 items
+    /// // Using borrows:
     ///
-    /// // $ curl localhost:8000/pages?size=5000
-    /// // failed with reason: number too large to fit in target type
+    /// #[derive(Deserialize)]
+    /// struct Query<'q> {
+    ///     format: &'q str,
+    /// }
     ///
-    /// // $ curl localhost:8000/pages?size=all
-    /// // failed with reason: invalid digit found in string
-    /// # Ok(()) })}
+    /// let req: Request<()> = http::Request::get("https://httpbin.org/get?format=bananna").into();
+    /// let Query { format } = req.query().unwrap();
+    /// assert_eq!(format, "bananna");
     /// ```
-
-    pub fn query<T: serde::de::DeserializeOwned>(&self) -> crate::Result<T> {
+    pub fn query<'de, T: serde::de::Deserialize<'de>>(&'de self) -> crate::Result<T> {
         self.req.query()
     }