botrs 0.12.2

A Rust QQ Bot framework based on QQ Guild Bot 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

use crate::models::serde_helpers::{is_zero_u32, option_is_none_or_default};
use base64::Engine;
use serde::{Deserialize, Serialize};

use super::{
    ActionButton, Ark, Embed, InputNotify, Keyboard, KeyboardPayload, MarkdownPayload, Media,
    MediaInfo, MessageCreateType, MessageToCreate, PromptKeyboard, Reference, Stream,
    option_message_type_is_none_or_zero,
};

macro_rules! channel_like_message_params_struct {
    (
        $(#[$meta:meta])*
        pub struct $name:ident;
    ) => {
        $(#[$meta])*
        #[derive(Debug, Clone, Default, Serialize, Deserialize)]
        pub struct $name {
            /// Message content
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub content: Option<String>,
            /// Message type
            #[serde(skip_serializing_if = "option_message_type_is_none_or_zero")]
            pub msg_type: Option<MessageCreateType>,
            /// Message embed
            #[serde(skip_serializing_if = "Option::is_none")]
            pub embed: Option<Embed>,
            /// Ark template
            #[serde(skip_serializing_if = "Option::is_none")]
            pub ark: Option<Ark>,
            /// Message reference
            #[serde(skip_serializing_if = "Option::is_none")]
            pub message_reference: Option<Reference>,
            /// Image URL
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub image: Option<String>,
            /// Base64 encoded file image
            #[serde(skip_serializing_if = "Option::is_none")]
            pub file_image: Option<String>,
            /// Message ID to reply to
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub msg_id: Option<String>,
            /// Event ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub event_id: Option<String>,
            /// Markdown payload
            #[serde(skip_serializing_if = "Option::is_none")]
            pub markdown: Option<MarkdownPayload>,
            /// Keyboard payload
            #[serde(skip_serializing_if = "Option::is_none")]
            pub keyboard: Option<Keyboard>,
            /// Deprecated timestamp field kept for backwards compatibility
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub timestamp: Option<i64>,
            /// Message sequence number
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub msg_seq: Option<u32>,
            /// Subscription ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub subscribe_id: Option<String>,
            /// Input status notification
            #[serde(skip_serializing_if = "Option::is_none")]
            pub input_notify: Option<InputNotify>,
            /// Rich media info
            #[serde(skip_serializing_if = "Option::is_none")]
            pub media: Option<MediaInfo>,
            /// Prompt keyboard
            #[serde(skip_serializing_if = "Option::is_none")]
            pub prompt_keyboard: Option<PromptKeyboard>,
            /// Action button
            #[serde(skip_serializing_if = "Option::is_none")]
            pub action_button: Option<ActionButton>,
            /// Stream info
            #[serde(skip_serializing_if = "Option::is_none")]
            pub stream: Option<Stream>,
            /// Feature control ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub feature_id: Option<u32>,
        }
    };
}

macro_rules! open_message_params_struct {
    (
        $(#[$meta:meta])*
        pub struct $name:ident;
    ) => {
        $(#[$meta])*
        #[derive(Debug, Clone, Default, Serialize, Deserialize)]
        pub struct $name {
            /// Message type (0=text, 1=rich text, 2=markdown, 3=ark, 4=embed, 7=media)
            #[serde(skip_serializing_if = "is_zero_u32")]
            pub msg_type: u32,
            /// Message content
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub content: Option<String>,
            /// Message embed
            #[serde(skip_serializing_if = "Option::is_none")]
            pub embed: Option<Embed>,
            /// Ark template
            #[serde(skip_serializing_if = "Option::is_none")]
            pub ark: Option<Ark>,
            /// Message reference
            #[serde(skip_serializing_if = "Option::is_none")]
            pub message_reference: Option<Reference>,
            /// Media attachment
            #[serde(skip_serializing_if = "Option::is_none")]
            pub media: Option<Media>,
            /// Message ID to reply to
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub msg_id: Option<String>,
            /// Message sequence number
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub msg_seq: Option<u32>,
            /// Event ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub event_id: Option<String>,
            /// Markdown payload
            #[serde(skip_serializing_if = "Option::is_none")]
            pub markdown: Option<MarkdownPayload>,
            /// Keyboard payload
            #[serde(skip_serializing_if = "Option::is_none")]
            pub keyboard: Option<KeyboardPayload>,
            /// Deprecated timestamp field kept for backwards compatibility
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub timestamp: Option<i64>,
            /// Subscription ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub subscribe_id: Option<String>,
            /// Input status notification
            #[serde(skip_serializing_if = "Option::is_none")]
            pub input_notify: Option<InputNotify>,
            /// Prompt keyboard
            #[serde(skip_serializing_if = "Option::is_none")]
            pub prompt_keyboard: Option<PromptKeyboard>,
            /// Action button
            #[serde(skip_serializing_if = "Option::is_none")]
            pub action_button: Option<ActionButton>,
            /// Stream info
            #[serde(skip_serializing_if = "Option::is_none")]
            pub stream: Option<Stream>,
            /// Feature control ID
            #[serde(skip_serializing_if = "option_is_none_or_default")]
            pub feature_id: Option<u32>,
        }
    };
}

channel_like_message_params_struct! {
    /// Parameters for sending a message to a channel.
    pub struct MessageParams;
}

open_message_params_struct! {
    /// Parameters for sending a group message.
    pub struct GroupMessageParams;
}

open_message_params_struct! {
    /// Parameters for sending a C2C (client-to-client) message.
    pub struct C2CMessageParams;
}

channel_like_message_params_struct! {
    /// Parameters for sending a direct message.
    pub struct DirectMessageParams;
}

macro_rules! impl_channel_like_message_params {
    ($name:ident) => {
        impl $name {
            /// Creates a new parameter object with text content.
            pub fn new_text(content: impl Into<String>) -> Self {
                Self {
                    content: Some(content.into()),
                    ..Default::default()
                }
            }

            /// Sets file image data, automatically encoding to base64.
            pub fn with_file_image(mut self, data: &[u8]) -> Self {
                self.file_image = Some(base64::engine::general_purpose::STANDARD.encode(data));
                self
            }

            /// Sets the message reference for replying.
            pub fn with_reply(mut self, message_id: impl Into<String>) -> Self {
                self.msg_id = Some(message_id.into());
                self
            }

            /// Converts this payload into the message create body.
            pub fn into_message_to_create(self) -> MessageToCreate {
                self.into()
            }
        }

        impl From<$name> for MessageToCreate {
            fn from(params: $name) -> Self {
                Self {
                    content: params.content,
                    msg_type: params.msg_type,
                    embed: params.embed,
                    ark: params.ark,
                    image: params.image,
                    msg_id: params.msg_id,
                    message_reference: params.message_reference,
                    markdown: params.markdown,
                    keyboard: params.keyboard,
                    event_id: params.event_id,
                    timestamp: params.timestamp,
                    msg_seq: params.msg_seq,
                    subscribe_id: params.subscribe_id,
                    input_notify: params.input_notify,
                    media: params.media,
                    prompt_keyboard: params.prompt_keyboard,
                    action_button: params.action_button,
                    stream: params.stream,
                    feature_id: params.feature_id,
                    file_image: params.file_image,
                }
            }
        }
    };
}

macro_rules! impl_open_message_params {
    ($name:ident) => {
        impl $name {
            /// Creates a new parameter object with text content.
            pub fn new_text(content: impl Into<String>) -> Self {
                Self {
                    msg_type: 0,
                    content: Some(content.into()),
                    ..Default::default()
                }
            }

            /// Sets the message reference for replying.
            pub fn with_reply(mut self, message_id: impl Into<String>) -> Self {
                self.msg_id = Some(message_id.into());
                self
            }

            /// Converts this payload into the message create body.
            pub fn into_message_to_create(self) -> MessageToCreate {
                self.into()
            }
        }

        impl From<$name> for MessageToCreate {
            fn from(params: $name) -> Self {
                Self {
                    content: params.content,
                    msg_type: Some(MessageCreateType::from(params.msg_type)),
                    embed: params.embed,
                    ark: params.ark,
                    msg_id: params.msg_id,
                    message_reference: params.message_reference,
                    markdown: params.markdown,
                    keyboard: params.keyboard.map(Into::into),
                    event_id: params.event_id,
                    timestamp: params.timestamp,
                    msg_seq: params.msg_seq,
                    subscribe_id: params.subscribe_id,
                    input_notify: params.input_notify,
                    media: params.media.map(Into::into),
                    prompt_keyboard: params.prompt_keyboard,
                    action_button: params.action_button,
                    stream: params.stream,
                    feature_id: params.feature_id,
                    ..Default::default()
                }
            }
        }
    };
}

impl_channel_like_message_params!(MessageParams);
impl_open_message_params!(GroupMessageParams);
impl_open_message_params!(C2CMessageParams);
impl_channel_like_message_params!(DirectMessageParams);