1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
//! `walrus_rs` is a Rust client library for interacting with the Walrus API.
//! It provides both asynchronous and blocking clients for users to choose from based on their needs.
//!
//! Key features include:
//! - Asynchronous and blocking communication with the Walrus API.
//! - Serialization/deserialization of requests and responses.
//! - Definition of API-related data models.
//! - Unified error handling mechanism.
//!
//! Module overview:
//! - [`client`]: Provides the asynchronous Walrus client [`WalrusClient`].
//! - [`blocking_client`]: Provides the blocking Walrus client [`BlockingWalrusClient`].
//! - [`models`]: Defines the data structures used by the Walrus API.
//! - [`error`]: Defines the library's error types [`WalrusError`].
//!
//! Examples:
//!
//! Asynchronous client usage example:
//! ```no_run
//! use walrus_rs::WalrusClient;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), walrus_rs::WalrusError> {
//! let client = WalrusClient::new("your_api_key".to_string());
//! // Perform API calls
//! // let response = client.some_api_call().await?;
//! // println!("{:?}", response);
//! Ok(())
//! }
//! ```
//!
//! Blocking client usage example:
//! ```no_run
//! use walrus_rs::BlockingWalrusClient;
//!
//! fn main() -> Result<(), walrus_rs::WalrusError> {
//! let client = BlockingWalrusClient::new("your_api_key".to_string());
//! // Perform API calls
//! // let response = client.some_api_call()?;
//! // println!("{:?}", response);
//! Ok(())
//! }
//! ```
//!
//! [`client`]: crate::client
//! [`blocking_client`]: crate::blocking_client
//! [`models`]: crate::models
//! [`error`]: crate::error
//! [`WalrusClient`]: crate::client::WalrusClient
//! [`BlockingWalrusClient`]: crate::blocking_client::BlockingWalrusClient
//! [`WalrusError`]: crate::error::WalrusError
pub use BlockingWalrusClient;
pub use WalrusClient;
pub use WalrusError;