Skip to content

Commit 81d2ded

Browse files
committed
Add doc
1 parent be7a7ff commit 81d2ded

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/search.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -743,6 +743,7 @@ impl<'a, 'b, Http: HttpClient> MultiSearchQuery<'a, 'b, Http> {
743743
queries: Vec::new(),
744744
}
745745
}
746+
746747
pub fn with_search_query(
747748
&mut self,
748749
mut search_query: SearchQuery<'b, Http>,
@@ -751,6 +752,7 @@ impl<'a, 'b, Http: HttpClient> MultiSearchQuery<'a, 'b, Http> {
751752
self.queries.push(search_query);
752753
self
753754
}
755+
754756
/// Adds the `federation` parameter, making the search a federated search.
755757
pub fn with_federation(
756758
self,
@@ -770,6 +772,7 @@ impl<'a, 'b, Http: HttpClient> MultiSearchQuery<'a, 'b, Http> {
770772
self.client.execute_multi_search_query::<T>(self).await
771773
}
772774
}
775+
773776
#[derive(Debug, Clone, Deserialize, Serialize)]
774777
pub struct MultiSearchResponse<T> {
775778
pub results: Vec<SearchResults<T>>,
@@ -791,12 +794,19 @@ pub struct FederatedMultiSearchQuery<'a, 'b, Http: HttpClient = DefaultHttpClien
791794
#[derive(Debug, Serialize, Clone, Default)]
792795
#[serde(rename_all = "camelCase")]
793796
pub struct FederationOptions {
797+
/// Number of documents to skip
794798
#[serde(skip_serializing_if = "Option::is_none")]
795799
pub offset: Option<usize>,
800+
801+
/// Maximum number of documents returned
796802
#[serde(skip_serializing_if = "Option::is_none")]
797803
pub limit: Option<usize>,
804+
805+
/// Display facet information for the specified indexes
798806
#[serde(skip_serializing_if = "Option::is_none")]
799807
pub facets_by_index: Option<HashMap<String, Vec<String>>>,
808+
809+
/// Display facet information for the specified indexes
800810
#[serde(skip_serializing_if = "Option::is_none")]
801811
pub merge_facets: Option<bool>,
802812
}

0 commit comments

Comments
 (0)