Merge #267

267: fixed formatting with clippy and removed Document trait r=brunoocasali a=irevoire

# Pull Request
Since `@honne23` doesn't seem available currently, and we have #262, #263, and #264 waiting for this PR to be merged, I took back on it.

But thanks a lot, `@honne23;` you wrote most of the code, and I just applied the few left comments.
Thanks for contributing!

## What does this PR do?
Fixes #255 
Closes #261

<!-- Please link the issue you're trying to fix with this PR, if none then please create an issue first. -->

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Co-authored-by: Adrian Coutsoftides <adrian.coutsoftides-ext@vitrifi.net>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -29,15 +29,11 @@ add_or_replace_documents_1: |-
   ], None).await.unwrap();
 add_or_update_documents_1: |-
   // Define the type of our documents
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct IncompleteMovie {
     id: usize,
     title: String
   }
-  impl Document for IncompleteMovie {
-    type UIDType = usize;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
 
   let task: Task = client.index("movies").add_or_update(&[
     IncompleteMovie {
@@ -369,7 +365,6 @@ settings_guide_sortable_1: |-
 add_movies_json_1: |-
   use meilisearch_sdk::{
     indexes::*,
-    document::*,
     client::*,
     search::*,
     settings::*
@@ -392,15 +387,11 @@ add_movies_json_1: |-
   })}
 documents_guide_add_movie_1: |-
   // Define the type of our documents
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct IncompleteMovie {
     id: String,
     title: String
   }
-  impl Document for IncompleteMovie {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
 
   // Add a document to our index
   let task: Task = client.index("movies").add_documents(&[
@@ -412,18 +403,14 @@ documents_guide_add_movie_1: |-
 document_guide_create_index_primary_key: |-
   client.create_index("movies", Some("reference_number")).await.unwrap();
 document_guide_add_document_primary_key: |-
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct Movie {
     id: String,
     title: String,
     poster: String,
     overview: String,
     release_date: String
   }
-  impl Document for Movie {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
 
   let task: Task = client.index("movies").add_documents(&[
     Movie {
@@ -447,10 +434,9 @@ getting_started_add_documents_md: |-
   ```
 
   Documents in the Rust library are strongly typed.
-  You have to implement the `Document` trait on a struct to be able to use it with Meilisearch.
 
   ```rust
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct Movie {
     id: String,
     title: String,
@@ -459,35 +445,25 @@ getting_started_add_documents_md: |-
     release_date: i64,
     genres: Vec<String>
   }
-  impl Document for Movie {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
   ```
 
   You will often need this `Movie` struct in other parts of this documentation. (you will have to change it a bit sometimes)
   You can also use schemaless values, by putting a `serde_json::Value` inside your own struct like this:
 
   ```rust
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct Movie {
     id: String,
     #[serde(flatten)]
     value: serde_json::Value,
   }
-
-  impl Document for Movie {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
   ```
 
   Then, add documents into the index:
 
   ```rust
   use meilisearch_sdk::{
     indexes::*,
-    document::*,
     client::*,
     search::*,
     settings::*
@@ -582,10 +558,10 @@ getting_started_communicating_with_a_protected_instance: |-
   let client = Client::new("http://localhost:7700", "apiKey");
   client.index("movies").search()
 getting_started_add_meteorites: |-
-  use serde::Deserialize;
+  use serde::{Serialize, Deserialize};
   use std::fs::File;
 
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct Geo {
     lat: f64,
     lon: f64
@@ -601,11 +577,6 @@ getting_started_add_meteorites: |-
     _geo: Geo
   }
 
-  impl Document for Meteorite {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
-
   let mut file = File::open("meteorites.json")?;
   let meteorites: Vec<Meteorite> = serde_json::from_reader(file)?;
 
@@ -807,15 +778,11 @@ security_guide_delete_key_1: |-
 landing_getting_started_1: |-
   let client = Client::new("http://localhost:7700", "masterKey");
 
-  #[derive(Serialize, Deserialize, Debug)]
+  #[derive(Serialize, Deserialize)]
   struct Movie {
     id: String,
     title: String
   }
-  impl Document for Movie {
-    type UIDType = String;
-    fn get_uid(&self) -> &Self::UIDType { &self.id }
-  }
 
   client.index("movies").add_documents(&[
     Movie { "id": "1".to_string(), "title": "Carol".to_string() },

README.md

@@ -88,7 +88,7 @@ NB: you can also download Meilisearch from **Homebrew** or **APT**.
 #### Add Documents <!-- omit in TOC -->
 
 ```rust
-use meilisearch_sdk::{document::*, client::*};
+use meilisearch_sdk::client::*;
 use serde::{Serialize, Deserialize};
 use futures::executor::block_on;
 
@@ -99,14 +99,6 @@ struct Movie {
     genres: Vec<String>,
 }
 
-// That trait is required to make a struct usable by an index
-impl Document for Movie {
-    type UIDType = usize;
-
-    fn get_uid(&self) -> &Self::UIDType {
-        &self.id
-    }
-}
 
 fn main() { block_on(async move {
     // Create a client (without sending any request so that can't fail)

examples/web_app/src/document.rs

@@ -1,4 +1,3 @@
-use meilisearch_sdk::document::Document;
 use serde::{Deserialize, Serialize};
 use serde_json::{Map, Value};
 use yew::prelude::*;
@@ -15,14 +14,6 @@ pub struct Crate {
 }
 
 // Implement the Document trait so that we can use our struct with Meilisearch
-impl Document for Crate {
-    type UIDType = String;
-
-    fn get_uid(&self) -> &Self::UIDType {
-        &self.name
-    }
-}
-
 fn get_readable_download_count(this: &Map<String, Value>) -> String {
     if let Some(downloads) = this["downloads"].as_f64() {
         if downloads < 1000.0 {

src/client.rs

@@ -176,7 +176,7 @@ impl Client {
         uid: impl AsRef<str>,
         primary_key: Option<&str>,
     ) -> Result<Task, Error> {
-        Ok(request::<Value, Task>(
+        request::<Value, Task>(
             &format!("{}/indexes", self.host),
             &self.api_key,
             Method::Post(json!({
@@ -185,19 +185,19 @@ impl Client {
             })),
             202,
         )
-        .await?)
+        .await
     }
 
     /// Delete an index from its UID.
     /// To delete an [Index], use the [Index::delete] method.
     pub async fn delete_index(&self, uid: impl AsRef<str>) -> Result<Task, Error> {
-        Ok(request::<(), Task>(
+        request::<(), Task>(
             &format!("{}/indexes/{}", self.host, uid.as_ref()),
             &self.api_key,
             Method::Delete,
             202,
         )
-        .await?)
+        .await
     }
 
     /// Alias for [Client::list_all_indexes].
@@ -467,7 +467,7 @@ impl Client {
     /// # Example
     ///
     /// ```
-    /// # use meilisearch_sdk::{client::*, document, indexes::*, tasks::Task};
+    /// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task};
     /// # use serde::{Serialize, Deserialize};
     /// #
     /// # #[derive(Debug, Serialize, Deserialize, PartialEq)]
@@ -477,13 +477,6 @@ impl Client {
     /// #    kind: String,
     /// # }
     /// #
-    /// # impl document::Document for Document {
-    /// #    type UIDType = usize;
-    /// #
-    /// #    fn get_uid(&self) -> &Self::UIDType {
-    /// #        &self.id
-    /// #    }
-    /// # }
     /// #
     /// # futures::executor::block_on(async move {
     /// let client = Client::new("http://localhost:7700", "masterKey");