Add support to the pagination setting customization at the index level

.code-samples.meilisearch.yaml

@@ -220,6 +220,26 @@ reset_synonyms_1: |-
     .reset_synonyms()
     .await
     .unwrap();
+get_pagination_settings_1: |-
+  let pagination: PaginationSetting = client
+    .index("movies")
+    .get_pagination()
+    .await
+    .unwrap();
+update_pagination_settings_1: |-
+  let pagination = PaginationSetting {max_total_hits:100};
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_pagination(pagination)
+    .await
+    .unwrap();
+reset_pagination_settings_1: |-
+  let task: TaskInfo = client
+    .index("movies")
+    .reset_pagination()
+    .await
+    .unwrap();
 get_stop_words_1: |-
   let stop_words: Vec<String> = client
     .index("movies")
@@ -635,6 +655,14 @@ settings_guide_searchable_1: |-
     .set_settings(&settings)
     .await
     .unwrap();
+settings_guide_pagination_1: |-
+  let pagination = PaginationSetting {max_total_hits:100};
+
+  let task: TaskInfo = client
+    .index("books")
+    .set_pagination(pagination)
+    .await
+    .unwrap();
 settings_guide_displayed_1: |-
   let settings = Settings::new()
     .with_displayed_attributes([

src/settings.rs

@@ -6,7 +6,11 @@ use crate::{
 };
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
-
+#[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Copy)]
+#[serde(rename_all = "camelCase")]
+pub struct PaginationSetting {
+    pub max_total_hits: u32
+}
 /// Struct reprensenting a set of settings.
 /// You can build this struct using the builder syntax.
 ///
@@ -58,6 +62,8 @@ pub struct Settings {
     /// Fields displayed in the returned documents
     #[serde(skip_serializing_if = "Option::is_none")]
     pub displayed_attributes: Option<Vec<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub pagination: Option<PaginationSetting>,
 }
 
 #[allow(missing_docs)]
@@ -73,6 +79,7 @@ impl Settings {
             distinct_attribute: None,
             searchable_attributes: None,
             displayed_attributes: None,
+            pagination: None,
         }
     }
     pub fn with_synonyms<S, U, V>(self, synonyms: HashMap<S, U>) -> Settings
@@ -112,6 +119,13 @@ impl Settings {
         }
     }
 
+    pub fn with_pagination(self, pagination_settings: PaginationSetting) -> Settings {
+        Settings {
+            pagination: Some(pagination_settings),
+            ..self
+        }
+    }
+
     pub fn with_ranking_rules(
         self,
         ranking_rules: impl IntoIterator<Item = impl AsRef<str>>,
@@ -251,6 +265,35 @@ impl Index {
         .await
     }
 
+    /// Get [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("get_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let index = client.index("get_pagination");
+    /// let pagination = index.get_pagination().await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn get_pagination(&self) -> Result<PaginationSetting, Error> {
+        request::<(), PaginationSetting>(
+            &format!(
+                "{}/indexes/{}/settings/pagination",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Get(()),
+            200,
+        )
+        .await
+    }
+
     /// Get [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
     ///
     /// ```
@@ -460,7 +503,7 @@ impl Index {
     /// # Example
     ///
     /// ```
-    /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings};
+    /// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings,PaginationSetting}};
     /// #
     /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
     /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -472,7 +515,9 @@ impl Index {
     ///
     /// let stop_words = vec![String::from("a"), String::from("the"), String::from("of")];
     /// let settings = Settings::new()
-    ///     .with_stop_words(stop_words.clone());
+    ///     .with_stop_words(stop_words.clone())
+    ///     .with_pagination(PaginationSetting {max_total_hits: 100}
+    /// );
     ///
     /// let task = index.set_settings(&settings).await.unwrap();
     /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
@@ -528,6 +573,38 @@ impl Index {
         .await
     }
 
+    /// Update [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings, PaginationSetting}};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("set_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let mut index = client.index("set_pagination");
+    /// let pagination = PaginationSetting {max_total_hits:100};
+    /// let task = index.set_pagination(pagination).await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn set_pagination(&self, pagination: PaginationSetting,) -> Result<TaskInfo, Error> {
+        request::<&PaginationSetting, TaskInfo>(
+            &format!(
+                "{}/indexes/{}/settings/pagination",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Patch(&pagination),
+            202,
+        )
+        .await
+    }
+
     /// Update [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
     ///
     /// # Example
@@ -878,6 +955,37 @@ impl Index {
         .await
     }
 
+    /// Reset [pagination](https://docs.meilisearch.com/learn/configuration/settings.html#pagination) of the [Index].
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("reset_pagination", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let mut index = client.index("reset_pagination");
+    ///
+    /// let task = index.reset_pagination().await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn reset_pagination(&self) -> Result<TaskInfo, Error> {
+        request::<(), TaskInfo>(
+            &format!(
+                "{}/indexes/{}/settings/pagination",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Delete,
+            202,
+        )
+        .await
+    }
     /// Reset [stop-words](https://docs.meilisearch.com/reference/features/stop_words.html) of the [Index].
     ///
     /// # Example
@@ -1103,3 +1211,49 @@ impl Index {
         .await
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    use crate::client::*;
+    use meilisearch_test_macro::meilisearch_test;
+
+    #[meilisearch_test]
+    async fn test_get_pagination(index: Index) {
+        let res = index.get_pagination().await.unwrap();
+        let pagination = PaginationSetting {
+            max_total_hits: 1000,
+        };
+
+        assert_eq!(pagination, res);
+    }
+
+    #[meilisearch_test]
+    async fn test_set_pagination(index: Index) {
+        let pagination = PaginationSetting {
+            max_total_hits: 11,
+        };
+        let task = index.set_pagination(pagination).await.unwrap();
+        index.wait_for_task(task, None, None).await.unwrap();
+        let res = index.get_pagination().await.unwrap();
+
+        assert_eq!(pagination, res);
+    }
+
+    #[meilisearch_test]
+    async fn test_reset_pagination(index: Index) {
+        let pagination = PaginationSetting {
+            max_total_hits: 10,
+        };
+        let task = index.set_pagination(pagination).await.unwrap();
+        index.wait_for_task(task, None, None).await.unwrap();
+        let reset_task = index.reset_pagination().await.unwrap();
+        index.wait_for_task(reset_task, None, None).await.unwrap();
+        let res = index.get_pagination().await.unwrap();
+
+        let default = PaginationSetting { max_total_hits: 1000};
+
+        assert_eq!(default, res);
+    }
+}