Merge #576

576: with_distrinct_attribute accepts None r=irevoire a=NoodleSamaChan

# Pull Request

## Related issue
Fixes #368

## What does this PR do?
- changed with_distinct_attribute so that it accepts None

## PR checklist
Please check if your PR fulfills the following requirements:
- [X] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [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: NoodleSamaChan <[email protected]>
Co-authored-by: NoodleSamaChan <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -315,7 +315,7 @@ update_settings_1: |-
       "release_date:desc",
       "rank:desc"
     ])
-    .with_distinct_attribute("movie_id")
+    .with_distinct_attribute(Some("movie_id"))
     .with_searchable_attributes([
       "title",
       "overview",

meilisearch-index-setting-macro/src/lib.rs

@@ -123,8 +123,10 @@ fn get_index_config_implementation(
         get_settings_token_for_list(&filterable_attributes, "with_filterable_attributes");
     let searchable_attr_tokens =
         get_settings_token_for_list(&searchable_attributes, "with_searchable_attributes");
-    let distinct_attr_token =
-        get_settings_token_for_string(&distinct_key_attribute, "with_distinct_attribute");
+    let distinct_attr_token = get_settings_token_for_string_for_some_string(
+        &distinct_key_attribute,
+        "with_distinct_attribute",
+    );
 
     quote! {
         #[::meilisearch_sdk::macro_helper::async_trait(?Send)]
@@ -173,7 +175,7 @@ fn get_settings_token_for_list(
     }
 }
 
-fn get_settings_token_for_string(
+fn get_settings_token_for_string_for_some_string(
     field_name: &String,
     method_name: &str,
 ) -> proc_macro2::TokenStream {
@@ -183,7 +185,7 @@ fn get_settings_token_for_string(
         proc_macro2::TokenStream::new()
     } else {
         quote! {
-            .#method_ident(#field_name)
+            .#method_ident(::std::option::Option::Some(#field_name))
         }
     }
 }

src/settings.rs

@@ -81,7 +81,7 @@ pub struct Settings {
     pub sortable_attributes: Option<Vec<String>>,
     /// Search returns documents with distinct (different) values of the given field.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub distinct_attribute: Option<String>,
+    pub distinct_attribute: Option<Option<String>>,
     /// Fields in which to search for matching query words sorted by order of importance.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub searchable_attributes: Option<Vec<String>>,
@@ -217,9 +217,11 @@ impl Settings {
     }
 
     #[must_use]
-    pub fn with_distinct_attribute(self, distinct_attribute: impl AsRef<str>) -> Settings {
+    pub fn with_distinct_attribute(self, distinct_attribute: Option<impl AsRef<str>>) -> Settings {
         Settings {
-            distinct_attribute: Some(distinct_attribute.as_ref().to_string()),
+            distinct_attribute: Some(
+                distinct_attribute.map(|distinct| distinct.as_ref().to_string()),
+            ),
             ..self
         }
     }