Skip to content

Commit 08a4524

Browse files
adriantombuadriantombu
committed
Re-export public structures for better import path
1 parent 4aa3fc9 commit 08a4524

File tree

15 files changed

+76
-104
lines changed

15 files changed

+76
-104
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: 3 additions & 9 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 {

‎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");

‎src/key.rs

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use serde::{Deserialize, Serialize};
22
use time::OffsetDateTime;
33

4-
use crate::{client::Client, errors::Error};
4+
use crate::{Client, Error};
55

66
/// Represents a [meilisearch key](https://www.meilisearch.com/docs/reference/api/keys#returned-fields).
77
///
@@ -33,7 +33,7 @@ impl Key {
3333
/// # Example
3434
///
3535
/// ```
36-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
36+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
3737
/// #
3838
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
3939
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -61,7 +61,7 @@ impl Key {
6161
/// # Example
6262
///
6363
/// ```
64-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
64+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
6565
/// #
6666
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
6767
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -92,7 +92,7 @@ impl Key {
9292
/// # Example
9393
///
9494
/// ```
95-
/// # use meilisearch_sdk::{key::KeyBuilder, client::Client};
95+
/// # use meilisearch_sdk::{KeyBuilder, Client};
9696
/// #
9797
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
9898
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -132,7 +132,7 @@ impl Key {
132132
/// # Example
133133
///
134134
/// ```
135-
/// # use meilisearch_sdk::{key::KeyBuilder, client::Client};
135+
/// # use meilisearch_sdk::{KeyBuilder, Client};
136136
/// #
137137
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
138138
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -185,7 +185,7 @@ impl KeyUpdater {
185185
/// # Example
186186
///
187187
/// ```
188-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client, key::KeyUpdater};
188+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client, KeyUpdater};
189189
/// #
190190
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
191191
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -218,7 +218,7 @@ impl KeyUpdater {
218218
/// # Example
219219
///
220220
/// ```
221-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client, key::KeyUpdater};
221+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client, KeyUpdater};
222222
/// #
223223
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
224224
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -251,7 +251,7 @@ impl KeyUpdater {
251251
/// # Example
252252
///
253253
/// ```
254-
/// # use meilisearch_sdk::{key::KeyBuilder, key::KeyUpdater, client::Client};
254+
/// # use meilisearch_sdk::{KeyBuilder, KeyUpdater, Client};
255255
/// #
256256
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
257257
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -327,7 +327,7 @@ impl KeysQuery {
327327
/// # Example
328328
///
329329
/// ```
330-
/// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client};
330+
/// # use meilisearch_sdk::{KeysQuery, Action, Client};
331331
/// #
332332
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
333333
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -351,7 +351,7 @@ impl KeysQuery {
351351
/// # Example
352352
///
353353
/// ```
354-
/// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client};
354+
/// # use meilisearch_sdk::{KeysQuery, Action, Client};
355355
/// #
356356
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
357357
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -375,7 +375,7 @@ impl KeysQuery {
375375
/// # Example
376376
///
377377
/// ```
378-
/// # use meilisearch_sdk::{key::KeysQuery, key::Action, client::Client};
378+
/// # use meilisearch_sdk::{KeysQuery, Action, Client};
379379
/// #
380380
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
381381
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -401,7 +401,7 @@ impl KeysQuery {
401401
/// # Example
402402
///
403403
/// ```
404-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
404+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
405405
/// #
406406
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
407407
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -438,7 +438,7 @@ impl KeyBuilder {
438438
/// # Example
439439
///
440440
/// ```
441-
/// # use meilisearch_sdk::{key::KeyBuilder};
441+
/// # use meilisearch_sdk::KeyBuilder;
442442
/// let builder = KeyBuilder::new();
443443
/// ```
444444
pub fn new() -> KeyBuilder {
@@ -450,7 +450,7 @@ impl KeyBuilder {
450450
/// # Example
451451
///
452452
/// ```
453-
/// # use meilisearch_sdk::key::{KeyBuilder, Action};
453+
/// # use meilisearch_sdk::{KeyBuilder, Action};
454454
/// let mut builder = KeyBuilder::new();
455455
/// builder.with_actions(vec![Action::Search, Action::DocumentsAdd]);
456456
/// ```
@@ -464,7 +464,7 @@ impl KeyBuilder {
464464
/// # Example
465465
///
466466
/// ```
467-
/// # use meilisearch_sdk::key::{KeyBuilder, Action};
467+
/// # use meilisearch_sdk::{KeyBuilder, Action};
468468
/// let mut builder = KeyBuilder::new();
469469
/// builder.with_action(Action::DocumentsAdd);
470470
/// ```
@@ -478,7 +478,7 @@ impl KeyBuilder {
478478
/// # Example
479479
///
480480
/// ```
481-
/// # use meilisearch_sdk::{key::KeyBuilder};
481+
/// # use meilisearch_sdk::KeyBuilder;
482482
/// # use time::{OffsetDateTime, Duration};
483483
/// let mut builder = KeyBuilder::new();
484484
/// // create a key that expires in two weeks from now
@@ -494,7 +494,7 @@ impl KeyBuilder {
494494
/// # Example
495495
///
496496
/// ```
497-
/// # use meilisearch_sdk::{key::KeyBuilder, client::Client};
497+
/// # use meilisearch_sdk::{KeyBuilder, Client};
498498
/// #
499499
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
500500
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -527,7 +527,7 @@ impl KeyBuilder {
527527
/// # Example
528528
///
529529
/// ```
530-
/// # use meilisearch_sdk::{key::KeyBuilder};
530+
/// # use meilisearch_sdk::KeyBuilder;
531531
/// let mut builder = KeyBuilder::new();
532532
/// builder.with_index("test");
533533
/// ```
@@ -541,7 +541,7 @@ impl KeyBuilder {
541541
/// # Example
542542
///
543543
/// ```
544-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
544+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
545545
/// #
546546
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
547547
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -567,7 +567,7 @@ impl KeyBuilder {
567567
/// # Example
568568
///
569569
/// ```
570-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
570+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
571571
/// #
572572
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
573573
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -593,7 +593,7 @@ impl KeyBuilder {
593593
/// # Example
594594
///
595595
/// ```
596-
/// # use meilisearch_sdk::{key::KeyBuilder, key::Action, client::Client};
596+
/// # use meilisearch_sdk::{KeyBuilder, Action, Client};
597597
/// #
598598
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
599599
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -619,7 +619,7 @@ impl KeyBuilder {
619619
/// # Example
620620
///
621621
/// ```
622-
/// # use meilisearch_sdk::{key::KeyBuilder, client::Client};
622+
/// # use meilisearch_sdk::{KeyBuilder, Client};
623623
/// #
624624
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
625625
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");

0 commit comments

Comments
 (0)