Merge #632

632: Add `indices` to `MatchRange` r=curquiza a=LukasKalbertodt

See meilisearch/meilisearch#5005

I already tested this with my production project, where it works as expected.

Unfortunately, I believe this is a breaking change. But shouldn't be a big problem, since this is still pre 1.0.

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


Co-authored-by: Lukas Kalbertodt <[email protected]>

Author: meili-bors[bot]

src/search.rs

@@ -10,6 +10,17 @@ use std::collections::HashMap;
 pub struct MatchRange {
     pub start: usize,
     pub length: usize,
+
+    /// If the match is somewhere inside a (potentially nested) array, this
+    /// field is set to the index/indices of the matched element(s).
+    ///
+    /// In the simple case, if the field has the value `["foo", "bar"]`, then
+    /// searching for `ba` will return `indices: Some([1])`. If the value
+    /// contains multiple nested arrays, the first index describes the most
+    /// top-level array, and descending from there. For example, if the value is
+    /// `[{ x: "cat" }, "bear", { y: ["dog", "fox"] }]`, searching for `dog`
+    /// will return `indices: Some([2, 0])`.
+    pub indices: Option<Vec<usize>>,
 }
 
 #[derive(Serialize, Debug, Eq, PartialEq, Clone)]
@@ -1122,7 +1133,8 @@ mod tests {
                 .unwrap(),
             &vec![MatchRange {
                 start: 0,
-                length: 5
+                length: 5,
+                indices: None,
             }]
         );
         Ok(())