You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/client.rs
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ pub struct Client<'a> {
13
13
impl<'a>Client<'a>{
14
14
/// Create a client using the specified server.
15
15
/// Don't put a '/' at the end of the host.
16
-
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html#authentication).
16
+
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
17
17
/// # Example
18
18
///
19
19
/// ```
@@ -207,12 +207,12 @@ impl<'a> Client<'a> {
207
207
}
208
208
209
209
/// Get the private and public key.
210
-
///
210
+
///
211
211
/// # Example
212
-
///
212
+
///
213
213
/// ```
214
214
/// # use meilisearch_sdk::{client::*, errors::Error};
215
-
/// #
215
+
/// #
216
216
/// # futures::executor::block_on(async move {
217
217
/// let client = Client::new("http://localhost:7700", "masterKey");
Copy file name to clipboardExpand all lines: src/search.rs
+33-33Lines changed: 33 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ pub struct MatchRange {
8
8
length:usize,
9
9
}
10
10
11
-
/// A single result.
11
+
/// A single result.
12
12
/// Contains the complete object, optionally the formatted object, and optionally an object that contains information about the matches.
13
13
#[derive(Deserialize,Debug)]
14
14
pubstructSearchResult<T>{
@@ -95,7 +95,7 @@ type AttributeToCrop<'a> = (&'a str, Option<usize>);
95
95
96
96
/// A struct representing a query.
97
97
/// You can add search parameters using the builder syntax.
98
-
/// See [this page](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html#query-q) for the official list and description of all parameters.
98
+
/// See [this page](https://docs.meilisearch.com/reference/features/search_parameters.html#query-q) for the official list and description of all parameters.
99
99
///
100
100
/// # Examples
101
101
///
@@ -125,68 +125,68 @@ type AttributeToCrop<'a> = (&'a str, Option<usize>);
125
125
pubstructQuery<'a>{
126
126
#[serde(skip_serializing)]
127
127
index:&'aIndex<'a>,
128
-
/// The text that will be searched for among the documents.
128
+
/// The text that will be searched for among the documents.
129
129
#[serde(skip_serializing_if = "Option::is_none")]
130
130
#[serde(rename = "q")]
131
131
pubquery:Option<&'astr>,
132
-
/// The number of documents to skip.
133
-
/// If the value of the parameter `offset` is `n`, the `n` first documents (ordered by relevance) will not be returned.
134
-
/// This is helpful for pagination.
135
-
///
136
-
/// Example: If you want to skip the first document, set offset to `1`.
132
+
/// The number of documents to skip.
133
+
/// If the value of the parameter `offset` is `n`, the `n` first documents (ordered by relevance) will not be returned.
134
+
/// This is helpful for pagination.
135
+
///
136
+
/// Example: If you want to skip the first document, set offset to `1`.
137
137
#[serde(skip_serializing_if = "Option::is_none")]
138
138
puboffset:Option<usize>,
139
-
/// The maximum number of documents returned.
140
-
/// If the value of the parameter `limit` is `n`, there will never be more than `n` documents in the response.
141
-
/// This is helpful for pagination.
142
-
///
143
-
/// Example: If you don't want to get more than two documents, set limit to `2`.
144
-
/// Default: `20`
139
+
/// The maximum number of documents returned.
140
+
/// If the value of the parameter `limit` is `n`, there will never be more than `n` documents in the response.
141
+
/// This is helpful for pagination.
142
+
///
143
+
/// Example: If you don't want to get more than two documents, set limit to `2`.
144
+
/// Default: `20`
145
145
#[serde(skip_serializing_if = "Option::is_none")]
146
146
publimit:Option<usize>,
147
-
/// Filters applied to documents.
148
-
/// Read the [dedicated guide](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to learn the syntax.
147
+
/// Filters applied to documents.
148
+
/// Read the [dedicated guide](https://docs.meilisearch.com/reference/features/filtering.html) to learn the syntax.
149
149
#[serde(skip_serializing_if = "Option::is_none")]
150
150
pubfilters:Option<&'astr>,
151
-
/// Facet names and values to filter on.
152
-
/// Read [this page](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html#facet-filters) for a complete explanation.
151
+
/// Facet names and values to filter on.
152
+
/// Read [this page](https://docs.meilisearch.com/reference/features/search_parameters.html#facet-filters) for a complete explanation.
153
153
#[serde(skip_serializing_if = "Option::is_none")]
154
154
pubfacet_filters:Option<&'a[&'a[&'astr]]>,
155
-
/// Facets for which to retrieve the matching count.
156
-
///
157
-
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
155
+
/// Facets for which to retrieve the matching count.
156
+
///
157
+
/// Can be set to a [wildcard value](enum.Selectors.html#variant.All) that will select all existing attributes.
158
158
/// Default: all attributes found in the documents.
/// Reset [attributes for faceting](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html) of the index.
566
+
/// Reset [attributes for faceting](https://docs.meilisearch.com/reference/features/faceted_search.html) of the index.
567
567
///
568
568
/// # Example
569
569
///
@@ -586,7 +586,7 @@ impl<'a> Index<'a> {
586
586
.into_progress(self))
587
587
}
588
588
589
-
/// Reset the [distinct attribute](https://docs.meilisearch.com/guides/advanced_guides/settings.html#distinct-attribute) of the index.
589
+
/// Reset the [distinct attribute](https://docs.meilisearch.com/reference/features/settings.html#distinct-attribute) of the index.
590
590
///
591
591
/// # Example
592
592
///
@@ -609,7 +609,7 @@ impl<'a> Index<'a> {
609
609
.into_progress(self))
610
610
}
611
611
612
-
/// Reset [searchable attributes](https://docs.meilisearch.com/guides/advanced_guides/field_properties.html#searchable-fields) of the index (enable all attributes).
612
+
/// Reset [searchable attributes](https://docs.meilisearch.com/reference/features/field_properties.html#searchable-fields) of the index (enable all attributes).
613
613
///
614
614
/// # Example
615
615
///
@@ -632,7 +632,7 @@ impl<'a> Index<'a> {
632
632
.into_progress(self))
633
633
}
634
634
635
-
/// Reset [displayed attributes](https://docs.meilisearch.com/guides/advanced_guides/settings.html#displayed-attributes) of the index (enable all attributes).
635
+
/// Reset [displayed attributes](https://docs.meilisearch.com/reference/features/settings.html#displayed-attributes) of the index (enable all attributes).
0 commit comments