Merge #112

112: Improve settings r=curquiza a=Mubelotix

Allow users to use a variety of data types when constructing `Settings` with the builder syntax.
Fix #38.


Co-authored-by: Mubelotix <[email protected]>

Author: bors[bot]

.code-samples.meilisearch.yaml

@@ -69,37 +69,37 @@ get_settings_1: |-
   let settings: Settings = movies.get_settings().await.unwrap();
 update_settings_1: |-
   let mut synonyms = std::collections::HashMap::new();
-  synonyms.insert(String::from("wolverine"), vec![String::from("xmen"), String::from("logan")]);
-  synonyms.insert(String::from("logan"), vec![String::from("wolverine")]);
+  synonyms.insert(String::from("wolverine"), vec!["xmen", "logan"]);
+  synonyms.insert(String::from("logan"), vec!["wolverine"]);
 
   let settings = Settings::new()
-    .with_ranking_rules(vec![
-      "typo".to_string(),
-      "words".to_string(),
-      "proximity".to_string(),
-      "attribute".to_string(),
-      "wordsPosition".to_string(),
-      "exactness".to_string(),
-      "desc(release_date)".to_string(),
-      "desc(rank)".to_string()
-    ])
-    .with_distinct_attribute("movie_id".to_string())
-    .with_searchable_attributes(vec![
-      "title".to_string(),
-      "description".to_string(),
-      "genre".to_string()
-    ])
-    .with_displayed_attributes(vec![
-      "title".to_string(),
-      "description".to_string(),
-      "genre".to_string(),
-      "release_date".to_string()
-    ])
-    .with_stop_words(vec![
-      "the".to_string(),
-      "a".to_string(),
-      "an".to_string()
-    ])
+    .with_ranking_rules(&[
+      "typo",
+      "words",
+      "proximity",
+      "attribute",
+      "wordsPosition",
+      "exactness",
+      "desc(release_date)",
+      "desc(rank)"
+    ][..])
+    .with_distinct_attribute("movie_id")
+    .with_searchable_attributes(&[
+      "title",
+      "description",
+      "genre"
+    ][..])
+    .with_displayed_attributes(&[
+      "title",
+      "description",
+      "genre",
+      "release_date"
+    ][..])
+    .with_stop_words(&[
+      "the",
+      "a",
+      "an"
+    ][..])
     .with_synonyms(synonyms);
 
   let progress: Progress = movies.set_settings(&settings).await.unwrap();
@@ -119,14 +119,14 @@ reset_synonyms_1: |-
 get_stop_words_1: |-
   let stop_words: Vec<String> = movies.get_stop_words().await.unwrap();
 update_stop_words_1: |-
-  let stop_words = &["of", "the", "to"];
-  let progress: Progress = movies.set_stop_words(stop_words).await.unwrap();
+  let stop_words = ["of", "the", "to"];
+  let progress: Progress = movies.set_stop_words(&stop_words[..]).await.unwrap();
 reset_stop_words_1: |-
   let progress: Progress = movies.reset_stop_words().await.unwrap();
 get_ranking_rules_1: |-
   let ranking_rules: Vec<String> = movies.get_ranking_rules().await.unwrap();
 update_ranking_rules_1: |-
-  let ranking_rules = &[
+  let ranking_rules = [
     "typo",
     "words",
     "proximity",
@@ -137,7 +137,7 @@ update_ranking_rules_1: |-
     "desc(rank)",
   ];
 
-  let progress: Progress = movies.set_ranking_rules(ranking_rules).await.unwrap();
+  let progress: Progress = movies.set_ranking_rules(&ranking_rules[..]).await.unwrap();
 reset_ranking_rules_1: |-
   let progress: Progress = movies.reset_ranking_rules().await.unwrap();
 get_distinct_attribute_1: |-
@@ -149,37 +149,37 @@ reset_distinct_attribute_1: |-
 get_searchable_attributes_1: |-
   let searchable_attributes: Vec<String> = movies.get_searchable_attributes().await.unwrap();
 update_searchable_attributes_1: |-
-  let searchable_attributes = &[
+  let searchable_attributes = [
     "title",
     "description",
     "genre"
   ];
 
-  let progress: Progress = movies.set_searchable_attributes(searchable_attributes).await.unwrap();
+  let progress: Progress = movies.set_searchable_attributes(&searchable_attributes[..]).await.unwrap();
 reset_searchable_attributes_1: |-
   let progress: Progress = movies.reset_searchable_attributes().await.unwrap();
 get_attributes_for_faceting_1: |-
   let attributes_for_faceting: Vec<String> = movies.get_attributes_for_faceting().await.unwrap();
 update_attributes_for_faceting_1: |-
-  let attributes_for_faceting = &[
+  let attributes_for_faceting = [
     "genres",
     "director"
   ];
 
-  let progress: Progress = movies.set_attributes_for_faceting(attributes_for_faceting).await.unwrap();
+  let progress: Progress = movies.set_attributes_for_faceting(&attributes_for_faceting[..]).await.unwrap();
 reset_attributes_for_faceting_1: |-
   let progress: Progress = movies.reset_attributes_for_faceting().await.unwrap();
 get_displayed_attributes_1: |-
   let displayed_attributes: Vec<String> = movies.get_displayed_attributes().await.unwrap();
 update_displayed_attributes_1: |-
-  let displayed_attributes = &[
+  let displayed_attributes = [
     "title",
     "description",
     "genre",
     "release_date"
   ];
 
-  let progress: Progress = movies.set_displayed_attributes(displayed_attributes).await.unwrap();
+  let progress: Progress = movies.set_displayed_attributes(&displayed_attributes[..]).await.unwrap();
 reset_displayed_attributes_1: |-
   let progress: Progress = movies.reset_displayed_attributes().await.unwrap();
 get_index_stats_1: |-
@@ -195,22 +195,22 @@ distinct_attribute_guide_1: |-
   let jackets: Index = client.get_index("jackets").await.unwrap();
   let progress: Progress = jackets.set_distinct_attribute("product_id").await.unwrap();
 field_properties_guide_searchable_1: |-
-  let searchable_attributes = &[
+  let searchable_attributes = [
     "title",
     "description",
     "genre"
   ];
 
-  let progress: Progress = movies.set_searchable_attributes(searchable_attributes).await.unwrap();
+  let progress: Progress = movies.set_searchable_attributes(&searchable_attributes[..]).await.unwrap();
 field_properties_guide_displayed_1: |-
-  let displayed_attributes = &[
+  let displayed_attributes = [
     "title",
     "description",
     "genre",
     "release_date"
   ];
 
-  let progress: Progress = movies.set_displayed_attributes(displayed_attributes).await.unwrap();
+  let progress: Progress = movies.set_displayed_attributes(&displayed_attributes[..]).await.unwrap();
 filtering_guide_1: |-
   let results: SearchResults<Movie> = movies.search()
     .with_query("Avengers")
@@ -321,11 +321,11 @@ settings_guide_synonyms_1: |-
   let tops: Index = client.get_index("tops").await.unwrap();
   let progress: Progress = tops.set_synonyms(&synonyms).await.unwrap();
 settings_guide_stop_words_1: |-
-  let progress: Progress = movies.set_stop_words(&["the", "a", "an"]).await.unwrap();
+  let progress: Progress = movies.set_stop_words(&["the", "a", "an"][..]).await.unwrap();
 settings_guide_attributes_for_faceting_1: |-
-  let progress: Progress = movies.set_attributes_for_faceting(&["director", "genres"]).await.unwrap();
+  let progress: Progress = movies.set_attributes_for_faceting(&["director", "genres"][..]).await.unwrap();
 settings_guide_ranking_rules_1: |-
-  let ranking_rules = &[
+  let ranking_rules = [
     "typo",
     "words",
     "proximity",
@@ -336,27 +336,27 @@ settings_guide_ranking_rules_1: |-
     "desc(rank)",
   ];
 
-  let progress: Progress = movies.set_ranking_rules(ranking_rules).await.unwrap();
+  let progress: Progress = movies.set_ranking_rules(&ranking_rules[..]).await.unwrap();
 settings_guide_distinct_1: |-
   let jackets: Index = client.get_index("jackets").await.unwrap();
   let progress: Progress = jackets.set_distinct_attribute("product_id").await.unwrap();
 settings_guide_searchable_1: |-
-  let searchable_attributes = &[
+  let searchable_attributes = [
     "title",
     "description",
     "genre"
   ];
 
-  let progress: Progress = movies.set_searchable_attributes(searchable_attributes).await.unwrap();
+  let progress: Progress = movies.set_searchable_attributes(&searchable_attributes[..]).await.unwrap();
 settings_guide_displayed_1: |-
-  let displayed_attributes = &[
+  let displayed_attributes = [
     "title",
     "description",
     "genre",
     "release_date"
   ];
 
-  let progress: Progress = movies.set_displayed_attributes(displayed_attributes).await.unwrap();
+  let progress: Progress = movies.set_displayed_attributes(&displayed_attributes[..]).await.unwrap();
 documents_guide_add_movie_1: |-
   // Define the type of our documents
   #[derive(Serialize, Deserialize, Debug)]
@@ -500,7 +500,7 @@ getting_started_search_md: |-
 
   [About this package](https://github.com/meilisearch/meilisearch-rust/)
 faceted_search_update_settings_1: |-
-  let progress: Progress = movies.set_attributes_for_faceting(&["director", "genres"]).await.unwrap();
+  let progress: Progress = movies.set_attributes_for_faceting(&["director", "genres"][..]).await.unwrap();
 faceted_search_facet_filters_1: |-
   let results: SearchResults<Movie> = movies.search()
     .with_query("thriller")
@@ -517,7 +517,14 @@ faceted_search_facets_distribution_1: |-
     .unwrap();
   let genres: &HashMap<String, usize> = results.facets_distribution.unwrap().get("genres").unwrap();
 faceted_search_walkthrough_attributes_for_faceting_1: |-
-  let progress: Progress = movies.set_attributes_for_faceting(&["director", "producer", "genres", "production_companies"]).await.unwrap();
+  let attributes_for_faceting = [
+    "director",
+    "producer",
+    "genres",
+    "production_companies"
+  ];
+
+  let progress: Progress = movies.set_attributes_for_faceting(&attributes_for_faceting[..]).await.unwrap();
 faceted_search_walkthrough_facet_filters_1: |-
   let results: SearchResults<Movie> = movies.search()
     .with_query("thriller")

src/search.rs

@@ -322,7 +322,7 @@ mod tests {
             Document { id: 8, kind: "title".into(), value: "Harry Potter and the Half-Blood Prince".to_string() },
             Document { id: 9, kind: "title".into(), value: "Harry Potter and the Deathly Hallows".to_string() },
         ], None).await.unwrap();
-        index.set_attributes_for_faceting(&["kind"]).await.unwrap();
+        index.set_attributes_for_faceting(&["kind"][..]).await.unwrap();
         sleep(Duration::from_secs(1));
         index
     }