tetr_ch 0.8.0

A Rust wrapper for the TETRA CHANNEL API.
Documentation 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

/// A macro to implement the method `get_user`.
///
/// # Methods
///
/// ```ignore
/// pub async fn get_user(&self) -> RspErr<Response<User>>
/// ```
///
/// # Dependencies
///
/// - `fn to_string(&self) -> String` method or `{specified field}: impl ToString` field
///
/// # Examples
///
/// By implementing the [`ToString`] trait:
///
/// ```ignore
/// use std::fmt;
///
/// pub struct UserId(String);
///
/// impl UserId {
///     impl_get_user!();
/// }
///
/// impl fmt::Display for UserId {
///     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
///         write!(f, "{}", self.0)
///     }
/// }
/// ```
///
/// By specifying a field:
///
/// ```ignore
/// pub struct PartialUser {
///     id: UserId,
///     username: String,
///     // ...
/// }
///
/// impl PartialUser {
///     impl_get_user!(id);
///     // or:
///     // impl_get_user!(username);
/// }
/// ```
///
/// Go to [String] | [ToString]
macro_rules! impl_get_user {
    () => {
        /// Gets the detailed information about the user.
        ///
        /// # Errors
        ///
        /// - A [`ResponseError::RequestErr`](crate::client::error::ResponseError::RequestErr) is returned,
        ///   if the request failed.
        /// - A [`ResponseError::DeserializeErr`](crate::client::error::ResponseError::DeserializeErr) is returned,
        ///   if the response did not match the expected format but the HTTP request succeeded.
        ///   There may be defectives in this wrapper or the TETRA CHANNEL API document.
        /// - A [`ResponseError::HttpErr`](crate::client::error::ResponseError::HttpErr) is returned,
        ///   if the HTTP request failed and the response did not match the expected format.
        ///   Even if the HTTP request failed,
        ///   it may be possible to deserialize the response containing an error message,
        ///   so the deserialization will be tried before returning this error.
        pub async fn get_user(
            &self,
        ) -> crate::client::error::RspErr<crate::model::response::Response<crate::model::user::User>> {
            crate::client::Client::new()
                .get_user(&self.to_string())
                .await
        }
    };
    ($field:ident) => {
        /// Gets the detailed information about the user.
        ///
        /// # Errors
        ///
        /// - A [`ResponseError::RequestErr`](crate::client::error::ResponseError::RequestErr) is returned,
        ///   if the request failed.
        /// - A [`ResponseError::DeserializeErr`](crate::client::error::ResponseError::DeserializeErr) is returned,
        ///   if the response did not match the expected format but the HTTP request succeeded.
        ///   There may be defectives in this wrapper or the TETRA CHANNEL API document.
        /// - A [`ResponseError::HttpErr`](crate::client::error::ResponseError::HttpErr) is returned,
        ///   if the HTTP request failed and the response did not match the expected format.
        ///   Even if the HTTP request failed,
        ///   it may be possible to deserialize the response containing an error message,
        ///   so the deserialization will be tried before returning this error.
        pub async fn get_user(
            &self,
        ) -> crate::client::error::RspErr<crate::model::response::Response<crate::model::user::User>> {
            crate::client::Client::new()
                .get_user(&self.$field.to_string())
                .await
        }
    };
}