Update get one document for v0.28.0

src/documents.rs

@@ -9,6 +9,13 @@ pub struct DocumentsResults<T> {
     pub total: u32,
 }
 
+#[derive(Debug, Clone, Serialize)]
+pub struct DocumentQuery<'a> {
+    /// The fields that should appear in the documents. By default all of the fields are present.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub fields: Option<Vec<&'a str>>,
+}
+
 #[derive(Debug, Clone, Serialize)]
 pub struct DocumentsQuery<'a> {
     #[serde(skip_serializing)]

src/indexes.rs

@@ -1,6 +1,6 @@
 use crate::{
     client::Client,
-    documents::{DocumentsQuery, DocumentsResults},
+    documents::{DocumentQuery, DocumentsQuery, DocumentsResults},
     errors::Error,
     request::*,
     search::*,
@@ -285,40 +285,48 @@ impl Index {
     /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
     /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
     /// #
-    /// #[derive(Serialize, Deserialize, Debug)]
-    /// # #[derive(PartialEq)]
+    /// #[derive(Serialize, Debug)]
     /// struct Movie {
     ///    name: String,
     ///    description: String,
+    ///    age: Option<usize>
+    /// }
+    ///
+    /// #[derive(Deserialize, Debug, PartialEq)]
+    /// struct ReturnedMovie {
+    ///    name: String,
+    ///    description: String
     /// }
     ///
     ///
     /// # futures::executor::block_on(async move {
     /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
     /// let movies = client.index("get_document");
-    /// # movies.add_or_replace(&[Movie{name:String::from("Interstellar"), description:String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.")}], Some("name")).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # movies.add_or_replace(&[Movie{name:String::from("Interstellar"), description:String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage."), age: Some(1)}], Some("name")).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     ///
     /// // retrieve a document (you have to put the document in the index before)
-    /// let interstellar = movies.get_document::<Movie>("Interstellar").await.unwrap();
+    /// let interstellar = movies.get_document::<ReturnedMovie>("Interstellar", Some(["name", "description"].to_vec())).await.unwrap();
     ///
-    /// assert_eq!(interstellar, Movie {
+    /// assert_eq!(interstellar, ReturnedMovie {
     ///     name: String::from("Interstellar"),
-    ///     description: String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.")
+    ///     description: String::from("Interstellar chronicles the adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage."),
     /// });
     /// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     /// # });
     /// ```
-    pub async fn get_document<T: 'static + DeserializeOwned>(&self, uid: &str) -> Result<T, Error> {
-        request::<(), T>(
-            &format!(
-                "{}/indexes/{}/documents/{}",
-                self.client.host, self.uid, uid
-            ),
-            &self.client.api_key,
-            Method::Get(()),
-            200,
-        )
-        .await
+    pub async fn get_document<T: 'static + DeserializeOwned>(
+        &self,
+        document_id: &str,
+        fields: Option<Vec<&str>>,
+    ) -> Result<T, Error> {
+        let url = format!(
+            "{}/indexes/{}/documents/{}",
+            self.client.host, self.uid, document_id
+        );
+
+        let query = DocumentQuery { fields };
+
+        request::<&DocumentQuery, T>(&url, &self.client.api_key, Method::Get(&query), 200).await
     }
 
     /// Get [Document]s by batch.