Merge #510

510: #499 (attributesToSearchOn) r=irevoire a=brendon-shf

# Pull Request

## Related issue
Fixes #499 

## What does this PR do?
- adds support for the attributesToSearchOn (which was added in meilisearch  v1.3) to the rust client as `with_attributes_to_search_on`

## 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: brendon-shf <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -692,6 +692,15 @@ search_parameter_guide_query_1: |-
     .execute()
     .await
     .unwrap();
+search_parameter_guide_attributes_to_search_on_1: |-
+  let results: SearchResults<Movie> = client
+    .index("movies")
+    .search()
+    .with_query("adventure")
+    .with_attributes_to_search_on(&["overview"])
+    .execute()
+    .await
+    .unwrap();
 search_parameter_guide_offset_1: |-
   let results: SearchResults<Movie> = client
     .index("movies")

src/search.rs

@@ -246,6 +246,13 @@ pub struct SearchQuery<'a> {
     /// Attributes to sort.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub sort: Option<&'a [&'a str]>,
+    /// Attributes to perform the search on.
+    ///
+    /// Specify the subset of searchableAttributes for a search without modifying Meilisearch’s index settings.
+    ///
+    /// **Default: all searchable attributes found in the documents.**
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub attributes_to_search_on: Option<&'a [&'a str]>,
     /// Attributes to display in the returned documents.
     ///
     /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
@@ -323,6 +330,7 @@ impl<'a> SearchQuery<'a> {
             filter: None,
             sort: None,
             facets: None,
+            attributes_to_search_on: None,
             attributes_to_retrieve: None,
             attributes_to_crop: None,
             crop_length: None,
@@ -430,6 +438,13 @@ impl<'a> SearchQuery<'a> {
         self.sort = Some(sort);
         self
     }
+    pub fn with_attributes_to_search_on<'b>(
+        &'b mut self,
+        attributes_to_search_on: &'a [&'a str],
+    ) -> &'b mut SearchQuery<'a> {
+        self.attributes_to_search_on = Some(attributes_to_search_on);
+        self
+    }
     pub fn with_attributes_to_retrieve<'b>(
         &'b mut self,
         attributes_to_retrieve: Selectors<&'a [&'a str]>,
@@ -830,6 +845,20 @@ mod tests {
         Ok(())
     }
 
+    #[meilisearch_test]
+    async fn test_query_attributes_to_search_on(client: Client, index: Index) -> Result<(), Error> {
+        setup_test_index(&client, &index).await?;
+
+        let results: SearchResults<Document> = index
+            .search()
+            .with_query("title")
+            .with_attributes_to_search_on(&["kind"])
+            .execute()
+            .await?;
+        assert_eq!(results.hits.len(), 8);
+        Ok(())
+    }
+
     #[meilisearch_test]
     async fn test_query_sort(client: Client, index: Index) -> Result<(), Error> {
         setup_test_index(&client, &index).await?;