Skip to content

Commit 039ad9d

Browse files
meili-bors[bot]adriantombu
meili-bors[bot]
and
adriantombu
authored
Merge #493
493: Re-export public structures for better import path r=bidoubiwa a=adriantombu # Pull Request ## Related issue Fixes #246 ## What does this PR do? - I think the PR title is already self-explanatory 😄 ## 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? Thank you so much for contributing to Meilisearch! Co-authored-by: Adrian Tombu <[email protected]>
2 parents 4aa3fc9 + c092bda commit 039ad9d

File tree

15 files changed

+88
-114
lines changed

15 files changed

+88
-114
lines changed

‎examples/cli-app/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use futures::executor::block_on;
22
use lazy_static::lazy_static;
3-
use meilisearch_sdk::{client::*, settings::Settings};
3+
use meilisearch_sdk::{client::*, Settings};
44
use serde::{Deserialize, Serialize};
55
use std::fmt;
66
use std::io::stdin;

‎examples/settings.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
use meilisearch_sdk::client::Client;
2-
use meilisearch_sdk::indexes::Index;
3-
use meilisearch_sdk::settings::Settings;
1+
use meilisearch_sdk::{Client, Index, Settings};
42

53
// we need an async runtime
64
#[tokio::main(flavor = "current_thread")]

‎examples/web_app/src/lib.rs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
#![recursion_limit = "512"]
22
use lazy_static::lazy_static;
3-
use meilisearch_sdk::{
4-
client::Client,
5-
indexes::Index,
6-
search::{SearchResults, Selectors::All},
7-
};
3+
use meilisearch_sdk::{Client, Index, SearchResults, Selectors::All};
84
use serde_json::{Map, Value};
95
use std::rc::Rc;
106
use wasm_bindgen::prelude::*;

‎src/client.rs

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,9 @@ use std::{collections::HashMap, time::Duration};
44
use time::OffsetDateTime;
55

66
use crate::{
7-
errors::*,
8-
indexes::*,
9-
key::{Key, KeyBuilder, KeyUpdater, KeysQuery, KeysResults},
10-
request::*,
11-
search::*,
12-
task_info::TaskInfo,
13-
tasks::{Task, TasksCancelQuery, TasksDeleteQuery, TasksResults, TasksSearchQuery},
14-
utils::async_sleep,
7+
errors::*, indexes::*, request::*, search::*, utils::async_sleep, Key, KeyBuilder, KeyUpdater,
8+
KeysQuery, KeysResults, Task, TaskInfo, TasksCancelQuery, TasksDeleteQuery, TasksResults,
9+
TasksSearchQuery,
1510
};
1611

1712
/// The top-level struct of the SDK, representing a client containing [indexes](../indexes/struct.Index.html).
@@ -500,7 +495,7 @@ impl Client {
500495
/// # Example
501496
///
502497
/// ```
503-
/// # use meilisearch_sdk::{client::*, errors::{Error, ErrorCode}};
498+
/// # use meilisearch_sdk::{client::*, Error, ErrorCode};
504499
/// #
505500
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
506501
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -554,7 +549,7 @@ impl Client {
554549
/// # Example
555550
///
556551
/// ```
557-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeysQuery};
552+
/// # use meilisearch_sdk::{client::*, Error, KeysQuery};
558553
/// #
559554
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
560555
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -588,7 +583,7 @@ impl Client {
588583
/// # Example
589584
///
590585
/// ```
591-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder};
586+
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
592587
/// #
593588
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
594589
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -619,7 +614,7 @@ impl Client {
619614
/// # Example
620615
///
621616
/// ```
622-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder};
617+
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
623618
/// #
624619
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
625620
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -651,7 +646,7 @@ impl Client {
651646
/// # Example
652647
///
653648
/// ```
654-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder};
649+
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder};
655650
/// #
656651
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
657652
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -686,7 +681,7 @@ impl Client {
686681
/// # Example
687682
///
688683
/// ```
689-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder, key::Action};
684+
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder, Action};
690685
/// #
691686
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
692687
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -723,7 +718,7 @@ impl Client {
723718
/// # Example
724719
///
725720
/// ```
726-
/// # use meilisearch_sdk::{client::*, errors::Error, key::KeyBuilder, key::KeyUpdater};
721+
/// # use meilisearch_sdk::{client::*, Error, KeyBuilder, KeyUpdater};
727722
/// #
728723
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
729724
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -794,7 +789,7 @@ impl Client {
794789
/// # Example
795790
///
796791
/// ```
797-
/// # use meilisearch_sdk::{client::*, indexes::*, tasks::Task};
792+
/// # use meilisearch_sdk::{client::*, indexes::*, Task};
798793
/// # use serde::{Serialize, Deserialize};
799794
/// #
800795
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
@@ -1105,11 +1100,7 @@ mod tests {
11051100

11061101
use meilisearch_test_macro::meilisearch_test;
11071102

1108-
use crate::{
1109-
client::*,
1110-
key::{Action, KeyBuilder},
1111-
tasks::TasksSearchQuery,
1112-
};
1103+
use crate::{client::*, Action, KeyBuilder, TasksSearchQuery};
11131104

11141105
#[derive(Debug, Serialize, Deserialize, PartialEq)]
11151106
struct Document {

‎src/documents.rs

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use crate::task_info::TaskInfo;
1+
use crate::TaskInfo;
22
use async_trait::async_trait;
33
use serde::{de::DeserializeOwned, Deserialize, Serialize};
44

@@ -20,10 +20,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
2020
/// ## Sample usage:
2121
/// ```
2222
/// use serde::{Serialize, Deserialize};
23-
/// use meilisearch_sdk::documents::IndexConfig;
24-
/// use meilisearch_sdk::settings::Settings;
25-
/// use meilisearch_sdk::indexes::Index;
26-
/// use meilisearch_sdk::client::Client;
23+
/// use meilisearch_sdk::{IndexConfig, Settings, Index, Client};
2724
///
2825
/// #[derive(Serialize, Deserialize, IndexConfig)]
2926
/// struct Movie {
@@ -48,10 +45,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
4845
/// ```
4946
pub use meilisearch_index_setting_macro::IndexConfig;
5047

51-
use crate::settings::Settings;
52-
use crate::tasks::Task;
53-
use crate::Client;
54-
use crate::{errors::Error, indexes::Index};
48+
use crate::{Client, Error, Index, Settings, Task};
5549

5650
#[async_trait]
5751
pub trait IndexConfig {
@@ -532,8 +526,8 @@ mod tests {
532526

533527
#[meilisearch_test]
534528
async fn test_get_documents_with_error_hint() -> Result<(), Error> {
535-
let url = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
536-
let client = Client::new(format!("{}/hello", url), Some("masterKey"));
529+
let meilisearch_url = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
530+
let client = Client::new(format!("{}/hello", meilisearch_url), Some("masterKey"));
537531
let index = client.index("test_get_documents_with_filter_wrong_ms_version");
538532

539533
let documents = DocumentsQuery::new(&index)
@@ -544,9 +538,11 @@ mod tests {
544538
let error = documents.unwrap_err();
545539

546540
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());
547-
let url = "http://localhost:7700/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch".to_string();
541+
let url = format!(
542+
"{meilisearch_url}/hello/indexes/test_get_documents_with_filter_wrong_ms_version/documents/fetch"
543+
);
548544
let status_code = 404;
549-
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";
545+
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");
550546

551547
match &error {
552548
Error::MeilisearchCommunication(error) => {

‎src/dumps.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
//! # });
3939
//! ```
4040
41-
use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo};
41+
use crate::{request::*, Client, Error, TaskInfo};
4242

4343
/// Dump related methods.
4444
/// See the [dumps](crate::dumps) module.

‎src/indexes.rs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
use crate::{
2-
client::Client,
3-
documents::{DocumentDeletionQuery, DocumentQuery, DocumentsQuery, DocumentsResults},
4-
errors::{Error, MeilisearchCommunicationError, MeilisearchError, MEILISEARCH_VERSION_HINT},
5-
request::*,
6-
search::*,
7-
task_info::TaskInfo,
8-
tasks::*,
2+
request::*, search::*, tasks::*, Client, DocumentDeletionQuery, DocumentQuery, DocumentsQuery,
3+
DocumentsResults, Error, MeilisearchCommunicationError, MeilisearchError, TaskInfo,
4+
MEILISEARCH_VERSION_HINT,
95
};
106
use serde::{de::DeserializeOwned, Deserialize, Serialize};
117
use std::{collections::HashMap, fmt::Display, time::Duration};
@@ -114,7 +110,7 @@ impl Index {
114110
/// # Example
115111
///
116112
/// ```
117-
/// # use meilisearch_sdk::{client::*, indexes::*, task_info::*, tasks::{Task, SucceededTask}};
113+
/// # use meilisearch_sdk::{client::*, indexes::*, task_info::*, Task, SucceededTask};
118114
/// #
119115
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
120116
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");

0 commit comments

Comments
 (0)