Merge #347

347: feat: Add `with_array_filter()` function to allow passing array as a filter list r=bidoubiwa a=VoidCupboard

## Related issue
Closes #163 

## What does this PR do?
Adds support to pass array as a filter 

## 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?

I am still learning Rust, and this is my first time Rust code contributing to any open source project 😅, let me know if I did something wrong.
Edit: The tests arent that good, I just added them to check if the function was working or not. Suggest me a better test!

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

Author: bors[bot]

Cargo.toml

@@ -20,6 +20,7 @@ serde_json = "1.0"
 time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsing"] }
 jsonwebtoken = { version = "8", default-features = false }
 yaup = "0.2.0"
+either = { version = "1.8.0" , features = ["serde"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 futures = "0.3"

src/search.rs

@@ -2,13 +2,29 @@ use crate::{errors::Error, indexes::Index};
 use serde::{de::DeserializeOwned, Deserialize, Serialize, Serializer};
 use serde_json::{Map, Value};
 use std::collections::HashMap;
+use either::Either;
 
 #[derive(Deserialize, Debug, Eq, PartialEq)]
 pub struct MatchRange {
     pub start: usize,
     pub length: usize,
 }
 
+#[derive(Serialize , Debug, Eq, PartialEq , Clone)]
+#[serde(transparent)]
+pub struct Filter<'a>{
+    #[serde(with = "either::serde_untagged")]
+    inner: Either<&'a str , Vec<&'a str>>
+}
+
+impl<'a> Filter<'a> {
+    pub fn new(inner: Either<&'a str , Vec<&'a str>>) -> Filter {
+        Filter {
+            inner
+        }
+    }
+}
+
 #[derive(Debug, Clone, Serialize)]
 pub enum MatchingStrategies {
     #[serde(rename = "all")]
@@ -182,7 +198,7 @@ pub struct SearchQuery<'a> {
     /// Filter applied to documents.
     /// Read the [dedicated guide](https://docs.meilisearch.com/reference/features/filtering.html) to learn the syntax.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub filter: Option<&'a str>,
+    pub filter: Option<Filter<'a>>,
     /// Facets for which to retrieve the matching count.
     ///
     /// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
@@ -284,7 +300,11 @@ impl<'a> SearchQuery<'a> {
         self
     }
     pub fn with_filter<'b>(&'b mut self, filter: &'a str) -> &'b mut SearchQuery<'a> {
-        self.filter = Some(filter);
+        self.filter = Some(Filter::new(Either::Left(filter)));
+        self
+    }
+    pub fn with_array_filter<'b>(&'b mut self , filter: Vec<&'a str>) -> &'b mut SearchQuery<'a> {
+        self.filter = Some(Filter::new(Either::Right(filter)));
         self
     }
     pub fn with_facets<'b>(
@@ -499,6 +519,21 @@ mod tests {
         Ok(())
     }
 
+    #[meilisearch_test]
+    async fn test_query_filter_with_array(client: Client, index: Index) -> Result<(), Error> {
+        setup_test_index(&client, &index).await?;
+
+        let results: SearchResults<Document> = index
+            .search()
+            .with_array_filter(vec!["value = \"The Social Network\"" , "value = \"The Social Network\""])
+            .execute()
+            .await?;
+        assert_eq!(results.hits.len(), 1);
+
+        Ok(())
+    }
+
+
     #[meilisearch_test]
     async fn test_query_facet_distribution(client: Client, index: Index) -> Result<(), Error> {
         setup_test_index(&client, &index).await?;