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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
use serde::{Deserialize, Serialize};
use crate::{
api::{Form, Method, Payload, PayloadError, WriteForm},
types::{
ChatId,
InputFile,
InputFileReader,
InputTextCaption,
Integer,
Message,
PhotoSize,
ReplyMarkup,
ReplyParameters,
SuggestedPostParameters,
},
};
/// Represents a general file (as opposed to photos, voice messages and audio files).
#[serde_with::skip_serializing_none]
#[derive(Clone, Debug, Deserialize, PartialEq, PartialOrd, Serialize)]
pub struct Document {
/// Identifier of the file.
///
/// Can be used to download or reuse the file.
pub file_id: String,
/// Unique identifier of the file.
///
/// It is supposed to be the same over time and for different bots.
/// Can't be used to download or reuse the file.
pub file_unique_id: String,
/// Original filename as defined by sender.
pub file_name: Option<String>,
/// File size in bytes.
pub file_size: Option<Integer>,
/// Document thumbnail as defined by sender.
pub thumbnail: Option<PhotoSize>,
/// MIME type as defined by sender.
pub mime_type: Option<String>,
}
/// Sends a general file.
///
/// Bots can currently send files of any type of up to 50 MB in size,
/// this limit may be changed in the future.
#[derive(Debug)]
pub struct SendDocument {
document: InputFile,
thumbnail: Option<InputFileReader>,
parameters: SendDocumentParameters,
}
impl SendDocument {
/// Creates a new `SendDocument`.
///
/// # Arguments
///
/// * `chat_id` - Unique identifier for the target chat.
/// * `document` - File to send.
pub fn new<A, B>(chat_id: A, document: B) -> Self
where
A: Into<ChatId>,
B: Into<InputFile>,
{
Self {
document: document.into(),
thumbnail: None,
parameters: SendDocumentParameters {
chat_id: Some(chat_id.into()),
..Default::default()
},
}
}
/// Sets a new value for the `allow_paid_broadcast` flag.
///
/// # Arguments
///
/// * `value` - Whether to allow up to 1000 messages per second, ignoring broadcasting limits
/// for a fee of 0.1 Telegram Stars per message.
/// The relevant Stars will be withdrawn from the bot's balance.
pub fn with_allow_paid_broadcast(mut self, value: bool) -> Self {
self.parameters.allow_paid_broadcast = Some(value);
self
}
/// Sets a new business connection ID.
///
/// # Arguments
///
/// * `value` - Unique identifier of the business connection.
pub fn with_business_connection_id<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.parameters.business_connection_id = Some(value.into());
self
}
/// Sets a new callback query ID.
///
/// # Arguments
///
/// * `value` - For outgoing ephemeral messages,
/// identifier of the callback query
/// which triggered the message if any.
pub fn with_callback_query_id<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.parameters.callback_query_id = Some(value.into());
self
}
/// Sets a new caption.
///
/// # Arguments
///
/// * `value` - Caption; 0-1024 characters.
///
/// May also be used when resending documents by `file_id`.
pub fn with_caption<T>(mut self, value: T) -> Self
where
T: Into<InputTextCaption>,
{
self.parameters.caption = Some(value.into());
self
}
/// Sets a new direct messages topic ID
///
/// * `value` - Identifier of the direct messages topic to which the message will be sent.
///
/// Required if the message is sent to a direct messages chat.
pub fn with_direct_messages_topic_id(mut self, value: Integer) -> Self {
self.parameters.direct_messages_topic_id = Some(value);
self
}
/// Sets a new value for the `disable_content_type_detection` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether to disable automatic server-side content type detection
/// for files uploaded using `multipart/form-data`.
pub fn with_disable_content_type_detection(mut self, value: bool) -> Self {
self.parameters.disable_content_type_detection = Some(value);
self
}
/// Sets a new value for the `disable_notification` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether to send the message silently or not;
/// a user will receive a notification without sound.
pub fn with_disable_notification(mut self, value: bool) -> Self {
self.parameters.disable_notification = Some(value);
self
}
/// Sets a new message effect ID.
///
/// # Arguments
///
/// * `value` - Unique identifier of the message effect to be added to the message; for private chats only.
pub fn with_message_effect_id<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.parameters.message_effect_id = Some(value.into());
self
}
/// Sets a new message thread ID.
///
/// # Arguments
///
/// * `value` - Unique identifier of the target message thread;
/// for forum supergroups and private chats of bots with forum topic mode enabled only.
pub fn with_message_thread_id(mut self, value: Integer) -> Self {
self.parameters.message_thread_id = Some(value);
self
}
/// Sets a new value for the `protect_content` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether to protect the contents
/// of the sent message from forwarding and saving.
pub fn with_protect_content(mut self, value: bool) -> Self {
self.parameters.protect_content = Some(value);
self
}
/// Sets a new receiver user ID.
///
/// # Arguments
///
/// * `value` - For outgoing ephemeral messages,
/// unique identifier of the user who will receive the message;
/// for group and supergroup chats only.
///
/// It is not guaranteed that the user will receive the message,
/// especially if they are offline.
pub fn with_receiver_user_id(mut self, value: Integer) -> Self {
self.parameters.receiver_user_id = Some(value);
self
}
/// Sets a new thumbnail.
///
/// # Arguments
///
/// * `value` - Thumbnail.
///
/// The thumbnail should be in JPEG format and less than 200 kB in size.
/// A thumbnail‘s width and height should not exceed 320.
pub fn with_thumbnail_file<T>(mut self, value: T) -> Self
where
T: Into<InputFileReader>,
{
self.thumbnail = Some(value.into());
self.parameters.thumbnail = None;
self
}
/// Sets a new thumbnail.
///
/// # Arguments
///
/// * `value` - Thumbnail.
///
/// The thumbnail should be in JPEG format and less than 200 kB in size.
/// A thumbnail‘s width and height should not exceed 320.
pub fn with_thumbnail_url<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.thumbnail = None;
self.parameters.thumbnail = Some(value.into());
self
}
/// Sets a new reply markup.
///
/// # Arguments
///
/// * `value` - Reply markup.
pub fn with_reply_markup<T>(mut self, value: T) -> Self
where
T: Into<ReplyMarkup>,
{
self.parameters.reply_markup = Some(value.into());
self
}
/// Sets new reply parameters.
///
/// # Arguments
///
/// * `value` - Description of the message to reply to.
pub fn with_reply_parameters(mut self, value: ReplyParameters) -> Self {
self.parameters.reply_parameters = Some(value);
self
}
/// Sets a new suggested post parameters.
///
/// # Arguments
///
/// * `value` - An object containing the parameters of the suggested post to send.
///
/// For direct messages chats only.
///
/// If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
pub fn with_suggested_post_parameters(mut self, value: SuggestedPostParameters) -> Self {
self.parameters.suggested_post_parameters = Some(value);
self
}
}
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Serialize)]
struct SendDocumentParameters {
allow_paid_broadcast: Option<bool>,
business_connection_id: Option<String>,
callback_query_id: Option<String>,
#[serde(flatten)]
caption: Option<InputTextCaption>,
chat_id: Option<ChatId>,
direct_messages_topic_id: Option<Integer>,
disable_content_type_detection: Option<bool>,
disable_notification: Option<bool>,
document: Option<String>,
message_effect_id: Option<String>,
message_thread_id: Option<Integer>,
protect_content: Option<bool>,
receiver_user_id: Option<Integer>,
reply_markup: Option<ReplyMarkup>,
reply_parameters: Option<ReplyParameters>,
suggested_post_parameters: Option<SuggestedPostParameters>,
thumbnail: Option<String>,
}
impl Method for SendDocument {
type Response = Message;
fn into_payload(self) -> Result<Payload, PayloadError> {
let Self {
document,
thumbnail,
mut parameters,
} = self;
let mut form = Form::default();
parameters.document = Some(document.write(&mut form));
parameters.thumbnail = parameters.thumbnail.or_else(|| thumbnail.map(|x| x.write(&mut form)));
parameters.serialize(&mut form)?;
Payload::form("sendDocument", form)
}
}