diff --git a/examples/cli-app/src/main.rs b/examples/cli-app/src/main.rs index 7d929db0..dd82e602 100644 --- a/examples/cli-app/src/main.rs +++ b/examples/cli-app/src/main.rs @@ -1,6 +1,6 @@ use futures::executor::block_on; use lazy_static::lazy_static; -use meilisearch_sdk::{client::*, settings::Settings}; +use meilisearch_sdk::{client::*, Settings}; use serde::{Deserialize, Serialize}; use std::fmt; use std::io::stdin; diff --git a/examples/settings.rs b/examples/settings.rs index aed6db68..1524ab8c 100644 --- a/examples/settings.rs +++ b/examples/settings.rs @@ -1,6 +1,4 @@ -use meilisearch_sdk::client::Client; -use meilisearch_sdk::indexes::Index; -use meilisearch_sdk::settings::Settings; +use meilisearch_sdk::{Client, Index, Settings}; // we need an async runtime #[tokio::main(flavor = "current_thread")] diff --git a/examples/web_app/src/lib.rs b/examples/web_app/src/lib.rs index 99e1de65..1a6d716b 100644 --- a/examples/web_app/src/lib.rs +++ b/examples/web_app/src/lib.rs @@ -1,10 +1,6 @@ #![recursion_limit = "512"] use lazy_static::lazy_static; -use meilisearch_sdk::{ - client::Client, - indexes::Index, - search::{SearchResults, Selectors::All}, -}; +use meilisearch_sdk::{Client, Index, SearchResults, Selectors::All}; use serde_json::{Map, Value}; use std::rc::Rc; use wasm_bindgen::prelude::*; diff --git a/src/client.rs b/src/client.rs index 89d338ed..bc6adbc6 100644 --- a/src/client.rs +++ b/src/client.rs @@ -4,14 +4,9 @@ use std::{collections::HashMap, time::Duration}; use time::OffsetDateTime; use crate::{ - errors::*, - indexes::*, - key::{Key, KeyBuilder, KeyUpdater, KeysQuery, KeysResults}, - request::*, - search::*, - task_info::TaskInfo, - tasks::{Task, TasksCancelQuery, TasksDeleteQuery, TasksResults, TasksSearchQuery}, - utils::async_sleep, + errors::*, indexes::*, request::*, search::*, utils::async_sleep, Key, KeyBuilder, KeyUpdater, + KeysQuery, KeysResults, Task, TaskInfo, TasksCancelQuery, TasksDeleteQuery, TasksResults, + TasksSearchQuery, }; /// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html). @@ -500,7 +495,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::{Error, ErrorCode}}; + /// # use meilisearch_sdk::{client::*, Error, ErrorCode}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -554,7 +549,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeysQuery}; + /// # use meilisearch_sdk::{client::*, Error, KeysQuery}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -588,7 +583,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder}; + /// # use meilisearch_sdk::{client::*, Error, KeyBuilder}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -619,7 +614,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder}; + /// # use meilisearch_sdk::{client::*, Error, KeyBuilder}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -651,7 +646,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder}; + /// # use meilisearch_sdk::{client::*, Error, KeyBuilder}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -686,7 +681,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder, key::Action}; + /// # use meilisearch_sdk::{client::*, Error, KeyBuilder, Action}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -723,7 +718,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder, key::KeyUpdater}; + /// # use meilisearch_sdk::{client::*, Error, KeyBuilder, KeyUpdater}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -794,7 +789,7 @@ impl Client { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task}; + /// # use meilisearch_sdk::{client::*, indexes::*, Task}; /// # use serde::{Serialize, Deserialize}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); @@ -1105,11 +1100,7 @@ mod tests { use meilisearch_test_macro::meilisearch_test; - use crate::{ - client::*, - key::{Action, KeyBuilder}, - tasks::TasksSearchQuery, - }; + use crate::{client::*, Action, KeyBuilder, TasksSearchQuery}; #[derive(Debug, Serialize, Deserialize, PartialEq)] struct Document { diff --git a/src/documents.rs b/src/documents.rs index 20d77a23..6c3c09f0 100644 --- a/src/documents.rs +++ b/src/documents.rs @@ -1,4 +1,4 @@ -use crate::task_info::TaskInfo; +use crate::TaskInfo; use async_trait::async_trait; use serde::{de::DeserializeOwned, Deserialize, Serialize}; @@ -20,10 +20,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize}; /// ## Sample usage: /// ``` /// use serde::{Serialize, Deserialize}; -/// use meilisearch_sdk::documents::IndexConfig; -/// use meilisearch_sdk::settings::Settings; -/// use meilisearch_sdk::indexes::Index; -/// use meilisearch_sdk::client::Client; +/// use meilisearch_sdk::{IndexConfig, Settings, Index, Client}; /// /// #[derive(Serialize, Deserialize, IndexConfig)] /// struct Movie { @@ -48,10 +45,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize}; /// ``` pub use meilisearch_index_setting_macro::IndexConfig; -use crate::settings::Settings; -use crate::tasks::Task; -use crate::Client; -use crate::{errors::Error, indexes::Index}; +use crate::{Client, Error, Index, Settings, Task}; #[async_trait] pub trait IndexConfig { @@ -532,8 +526,8 @@ mod tests { #[meilisearch_test] async fn test_get_documents_with_error_hint() -> Result<(), Error> { - let url = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); - let client = Client::new(format!("{}/hello", url), Some("masterKey")); + let meilisearch_url = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); + let client = Client::new(format!("{}/hello", meilisearch_url), Some("masterKey")); let index = client.index("test_get_documents_with_filter_wrong_ms_version"); let documents = DocumentsQuery::new(&index) @@ -544,9 +538,11 @@ mod tests { let error = documents.unwrap_err(); let message = Some("Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.".to_string()); - let url = "http://localhost:7700/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch".to_string(); + let url = format!( + "{meilisearch_url}/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch" + ); let status_code = 404; - let displayed_error = "MeilisearchCommunicationError: The server responded with a 404. Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.\nurl: http://localhost:7700/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch"; + let displayed_error = format!("MeilisearchCommunicationError: The server responded with a 404. Hint: It might not be working because you're not up to date with the Meilisearch version that updated the get_documents_with method.\nurl: {meilisearch_url}/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch"); match &error { Error::MeilisearchCommunication(error) => { diff --git a/src/dumps.rs b/src/dumps.rs index c71bead3..6f112a1a 100644 --- a/src/dumps.rs +++ b/src/dumps.rs @@ -38,7 +38,7 @@ //! # }); //! ``` -use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo}; +use crate::{request::*, Client, Error, TaskInfo}; /// Dump related methods. /// See the [dumps](crate::dumps) module. diff --git a/src/indexes.rs b/src/indexes.rs index fee4e448..70ec1406 100644 --- a/src/indexes.rs +++ b/src/indexes.rs @@ -1,11 +1,7 @@ use crate::{ - client::Client, - documents::{DocumentDeletionQuery, DocumentQuery, DocumentsQuery, DocumentsResults}, - errors::{Error, MeilisearchCommunicationError, MeilisearchError, MEILISEARCH_VERSION_HINT}, - request::*, - search::*, - task_info::TaskInfo, - tasks::*, + request::*, search::*, tasks::*, Client, DocumentDeletionQuery, DocumentQuery, DocumentsQuery, + DocumentsResults, Error, MeilisearchCommunicationError, MeilisearchError, TaskInfo, + MEILISEARCH_VERSION_HINT, }; use serde::{de::DeserializeOwned, Deserialize, Serialize}; use std::{collections::HashMap, fmt::Display, time::Duration}; @@ -114,7 +110,7 @@ impl Index { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, task_info::*, tasks::{Task, SucceededTask}}; + /// # use meilisearch_sdk::{client::*, indexes::*, task_info::*, Task, SucceededTask}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); diff --git a/src/key.rs b/src/key.rs index f8224e2f..1cf92afb 100644 --- a/src/key.rs +++ b/src/key.rs @@ -1,7 +1,7 @@ use serde::{Deserialize, Serialize}; use time::OffsetDateTime; -use crate::{client::Client, errors::Error}; +use crate::{Client, Error}; /// Represents a [meilisearch key](https://www.meilisearch.com/docs/reference/api/keys#returned-fields). /// @@ -33,7 +33,7 @@ impl Key { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -61,7 +61,7 @@ impl Key { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -92,7 +92,7 @@ impl Key { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -132,7 +132,7 @@ impl Key { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -185,7 +185,7 @@ impl KeyUpdater { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client, key::KeyUpdater}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client, KeyUpdater}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -218,7 +218,7 @@ impl KeyUpdater { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client, key::KeyUpdater}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client, KeyUpdater}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -251,7 +251,7 @@ impl KeyUpdater { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::KeyUpdater, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, KeyUpdater, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -327,7 +327,7 @@ impl KeysQuery { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeysQuery, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -351,7 +351,7 @@ impl KeysQuery { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeysQuery, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -375,7 +375,7 @@ impl KeysQuery { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeysQuery, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -401,7 +401,7 @@ impl KeysQuery { /// # Example /// /// ``` -/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; +/// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -438,7 +438,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder}; + /// # use meilisearch_sdk::KeyBuilder; /// let builder = KeyBuilder::new(); /// ``` pub fn new() -> KeyBuilder { @@ -450,7 +450,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::key::{KeyBuilder, Action}; + /// # use meilisearch_sdk::{KeyBuilder, Action}; /// let mut builder = KeyBuilder::new(); /// builder.with_actions(vec![Action::Search, Action::DocumentsAdd]); /// ``` @@ -464,7 +464,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::key::{KeyBuilder, Action}; + /// # use meilisearch_sdk::{KeyBuilder, Action}; /// let mut builder = KeyBuilder::new(); /// builder.with_action(Action::DocumentsAdd); /// ``` @@ -478,7 +478,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder}; + /// # use meilisearch_sdk::KeyBuilder; /// # use time::{OffsetDateTime, Duration}; /// let mut builder = KeyBuilder::new(); /// // create a key that expires in two weeks from now @@ -494,7 +494,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -527,7 +527,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder}; + /// # use meilisearch_sdk::KeyBuilder; /// let mut builder = KeyBuilder::new(); /// builder.with_index("test"); /// ``` @@ -541,7 +541,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -567,7 +567,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -593,7 +593,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Action, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -619,7 +619,7 @@ impl KeyBuilder { /// # Example /// /// ``` - /// # use meilisearch_sdk::{key::KeyBuilder, client::Client}; + /// # use meilisearch_sdk::{KeyBuilder, Client}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); diff --git a/src/lib.rs b/src/lib.rs index f1a3fba7..d90ec104 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -250,6 +250,15 @@ mod tenant_tokens; mod utils; pub use client::*; +pub use documents::*; +pub use dumps::*; +pub use errors::*; +pub use indexes::*; +pub use key::*; +pub use search::*; +pub use settings::*; +pub use task_info::*; +pub use tasks::*; #[cfg(test)] /// Support for the `IndexConfig` derive proc macro in the crate's tests. diff --git a/src/request.rs b/src/request.rs index eef9977f..c3b35d55 100644 --- a/src/request.rs +++ b/src/request.rs @@ -1,4 +1,4 @@ -use crate::errors::{Error, MeilisearchCommunicationError, MeilisearchError}; +use crate::{Error, MeilisearchCommunicationError, MeilisearchError}; use log::{error, trace, warn}; use serde::{de::DeserializeOwned, Serialize}; use serde_json::{from_str, to_string}; diff --git a/src/search.rs b/src/search.rs index 2115a0d0..1752ebcf 100644 --- a/src/search.rs +++ b/src/search.rs @@ -1,4 +1,4 @@ -use crate::{client::Client, errors::Error, indexes::Index}; +use crate::{Client, Error, Index}; use either::Either; use serde::{de::DeserializeOwned, Deserialize, Serialize, Serializer}; use serde_json::{Map, Value}; @@ -143,7 +143,7 @@ type AttributeToCrop<'a> = (&'a str, Option); /// /// ``` /// # use serde::{Serialize, Deserialize}; -/// # use meilisearch_sdk::{client::Client, search::SearchQuery, indexes::Index}; +/// # use meilisearch_sdk::{Client, SearchQuery, Index}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -178,7 +178,7 @@ type AttributeToCrop<'a> = (&'a str, Option); /// ``` /// /// ``` -/// # use meilisearch_sdk::{client::Client, search::SearchQuery, indexes::Index}; +/// # use meilisearch_sdk::{Client, SearchQuery, Index}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -1074,7 +1074,7 @@ mod tests { client: Client, index: Index, ) -> Result<(), Error> { - use crate::key::{Action, KeyBuilder}; + use crate::{Action, KeyBuilder}; setup_test_index(&client, &index).await?; diff --git a/src/settings.rs b/src/settings.rs index 67bf9344..430f8ea1 100644 --- a/src/settings.rs +++ b/src/settings.rs @@ -1,8 +1,6 @@ use crate::{ - errors::Error, - indexes::Index, request::{request, Method}, - task_info::TaskInfo, + Error, Index, TaskInfo, }; use serde::{Deserialize, Serialize}; use std::collections::HashMap; @@ -43,7 +41,7 @@ pub struct FacetingSettings { /// # Example /// /// ``` -/// # use meilisearch_sdk::settings::Settings; +/// # use meilisearch_sdk::Settings; /// let settings = Settings::new() /// .with_stop_words(["a", "the", "of"]); /// @@ -611,11 +609,11 @@ impl Index { /// ``` /// # use meilisearch_sdk::{client::*, indexes::*}; /// # - /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700"); + /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").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, Some(MEILISEARCH_API_KEY)); + /// let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)); /// # client.create_index("get_typo_tolerance", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap(); /// let index = client.index("get_typo_tolerance"); /// @@ -643,7 +641,7 @@ impl Index { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings, PaginationSetting}}; + /// # use meilisearch_sdk::{client::*, indexes::*, Settings, PaginationSetting}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -681,7 +679,7 @@ impl Index { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings}; + /// # use meilisearch_sdk::{client::*, indexes::*, Settings}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -724,7 +722,7 @@ impl Index { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, settings::{Settings, PaginationSetting}}; + /// # use meilisearch_sdk::{client::*, indexes::*, Settings, PaginationSetting}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -760,7 +758,7 @@ impl Index { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings}; + /// # use meilisearch_sdk::{client::*, indexes::*, Settings}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -1098,11 +1096,11 @@ impl Index { /// ``` /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings, settings::{TypoToleranceSettings, MinWordSizeForTypos}}; /// # - /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700"); + /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").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, Some(MEILISEARCH_API_KEY)); + /// let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)); /// # client.create_index("set_typo_tolerance", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap(); /// let mut index = client.index("set_typo_tolerance"); /// @@ -1496,11 +1494,11 @@ impl Index { /// ``` /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings}; /// # - /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700"); + /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").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, Some(MEILISEARCH_API_KEY)); + /// let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)); /// # client.create_index("reset_typo_tolerance", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap(); /// let mut index = client.index("reset_typo_tolerance"); /// diff --git a/src/task_info.rs b/src/task_info.rs index dd848eb4..4cb0a3d2 100644 --- a/src/task_info.rs +++ b/src/task_info.rs @@ -2,7 +2,7 @@ use serde::Deserialize; use std::time::Duration; use time::OffsetDateTime; -use crate::{client::Client, errors::Error, tasks::*}; +use crate::{tasks::*, Client, Error}; #[derive(Debug, Clone, Deserialize)] #[serde(rename_all = "camelCase")] @@ -40,7 +40,7 @@ impl TaskInfo { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task, task_info::TaskInfo}; + /// # use meilisearch_sdk::{client::*, indexes::*, Task, TaskInfo}; /// # use serde::{Serialize, Deserialize}; /// # /// # #[derive(Debug, Serialize, Deserialize, PartialEq)] @@ -84,11 +84,7 @@ impl TaskInfo { #[cfg(test)] mod test { use super::*; - use crate::{ - client::*, - errors::{ErrorCode, ErrorType}, - indexes::Index, - }; + use crate::{client::*, ErrorCode, ErrorType, Index}; use big_s::S; use meilisearch_test_macro::meilisearch_test; use serde::{Deserialize, Serialize}; diff --git a/src/tasks.rs b/src/tasks.rs index c1a781cb..fd930239 100644 --- a/src/tasks.rs +++ b/src/tasks.rs @@ -2,10 +2,7 @@ use serde::{Deserialize, Deserializer, Serialize}; use std::time::Duration; use time::OffsetDateTime; -use crate::{ - client::Client, errors::Error, errors::MeilisearchError, indexes::Index, settings::Settings, - task_info::TaskInfo, SwapIndexes, -}; +use crate::{Client, Error, Index, MeilisearchError, Settings, SwapIndexes, TaskInfo}; #[derive(Debug, Clone, Deserialize)] #[serde(rename_all = "camelCase", tag = "type")] @@ -227,7 +224,7 @@ impl Task { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task}; + /// # use meilisearch_sdk::{client::*, indexes::*, Task}; /// # use serde::{Serialize, Deserialize}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); @@ -313,7 +310,7 @@ impl Task { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, errors::ErrorCode}; + /// # use meilisearch_sdk::{client::*, indexes::*, ErrorCode}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -351,7 +348,7 @@ impl Task { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, errors::ErrorCode}; + /// # use meilisearch_sdk::{client::*, indexes::*, ErrorCode}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -381,7 +378,7 @@ impl Task { /// # Example /// /// ``` - /// # use meilisearch_sdk::{client::*, indexes::*, errors::ErrorCode}; + /// # use meilisearch_sdk::{client::*, indexes::*, ErrorCode}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -410,7 +407,7 @@ impl Task { /// ```no_run /// # // The test is not run because it checks for an enqueued or processed status /// # // and the task might already be processed when checking the status after the get_task call - /// # use meilisearch_sdk::{client::*, indexes::*, errors::ErrorCode}; + /// # use meilisearch_sdk::{client::*, indexes::*, ErrorCode}; /// # /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700"); /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey"); @@ -695,10 +692,7 @@ impl<'a> TasksQuery<'a, TasksPaginationFilters> { #[cfg(test)] mod test { use super::*; - use crate::{ - client::*, - errors::{ErrorCode, ErrorType}, - }; + use crate::{client::*, ErrorCode, ErrorType}; use big_s::S; use meilisearch_test_macro::meilisearch_test; use serde::{Deserialize, Serialize}; diff --git a/src/tenant_tokens.rs b/src/tenant_tokens.rs index ea9bab98..aaec648d 100644 --- a/src/tenant_tokens.rs +++ b/src/tenant_tokens.rs @@ -1,4 +1,4 @@ -use crate::errors::*; +use crate::Error; use jsonwebtoken::{encode, EncodingKey, Header}; use serde::{Deserialize, Serialize}; use serde_json::Value;