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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
use std::fmt::Display;
use super::{Formatter, FormatterErrorKind};
use crate::types::{
MessageEntity, MessageEntityBlockquote, MessageEntityBold, MessageEntityBotCommand,
MessageEntityCashtag, MessageEntityCode, MessageEntityCustomEmoji, MessageEntityEmail,
MessageEntityExpandableBlockquote, MessageEntityHashtag, MessageEntityItalic,
MessageEntityMention, MessageEntityPhoneNumber, MessageEntityPre, MessageEntitySpoiler,
MessageEntityStrikethrough, MessageEntityTextLink, MessageEntityTextMention,
MessageEntityUnderline, MessageEntityUrl, User,
};
use tracing::{event, Level};
#[derive(Debug, Default)]
pub struct Builder<F> {
formatter: F,
text: String,
}
#[allow(clippy::cast_possible_truncation, clippy::missing_panics_doc)]
impl<F> Builder<F>
where
F: Formatter,
{
#[inline]
#[must_use]
pub const fn new(formatter: F) -> Self {
Self {
formatter,
text: String::new(),
}
}
/// Add text without formatting.
#[must_use]
pub fn text(mut self, text: impl Display) -> Self {
self.text.push_str(text.to_string().as_ref());
self
}
/// Add texts without formatting.
#[must_use]
pub fn texts<T, I>(mut self, texts: I) -> Self
where
String: Extend<T>,
I: IntoIterator<Item = T>,
T: Display,
{
self.text.extend(texts);
self
}
/// Add quote text without formatting.
#[must_use]
pub fn quote(mut self, text: impl Display) -> Self {
self.text.push_str(self.formatter.quote(text).as_str());
self
}
/// Add quote texts without formatting.
#[must_use]
pub fn quotes<T, I>(mut self, texts: I) -> Self
where
I: IntoIterator<Item = T>,
T: Display,
{
self.text.extend(
texts
.into_iter()
.map(|text| self.formatter.quote(text))
.collect::<Box<[_]>>()
.iter()
.map(String::as_str),
);
self
}
/// Add entity to the builder.
/// # Arguments
/// * `entity` - Entity that will be added to the builder.
/// # Notes
/// You can use this method if you want to add entity that is not supported by this builder
/// # Errors
/// - If the given text is empty, then the [`FormatterErrorKind::EmptyText`] will be returned.
/// - If the given entity offset+length is out of bounds, then the [`FormatterErrorKind::IndexOutOfBounds`] will be returned.
pub fn entity(mut self, entity: &MessageEntity) -> Result<Self, FormatterErrorKind> {
event!(
Level::TRACE,
text = self.text,
?entity,
"Add entity for the text"
);
self.formatter
.apply_entity(self.text.as_str(), entity)
.map(|text| {
self.text = text;
self
})
}
/// Add mention by username.
/// # Arguments
/// * `username` - Username which will be mentioned.
/// # Notes
/// If you want to mention user without username, then use `text_mention` method instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn mention(self, username: impl Into<Box<str>>) -> Self {
let username = username.into();
let entity = MessageEntity::Mention(MessageEntityMention::new(
self.text.len() as u16,
username.len() as u16,
));
self.text(username)
.entity(&entity)
.expect("Failed to add mention. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn hashtag(self, tag: impl Into<Box<str>>) -> Self {
let tag = tag.into();
let entity = MessageEntity::Hashtag(MessageEntityHashtag::new(
self.text.len() as u16,
tag.len() as u16,
));
self.text(tag)
.entity(&entity)
.expect("Failed to add hashtag. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn cashtag(self, tag: impl Into<Box<str>>) -> Self {
let tag = tag.into();
let entity = MessageEntity::Cashtag(MessageEntityCashtag::new(
self.text.len() as u16,
tag.len() as u16,
));
self.text(tag)
.entity(&entity)
.expect("Failed to add cashtag. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn bot_command(self, command: impl Into<Box<str>>) -> Self {
let command = command.into();
let entity = MessageEntity::BotCommand(MessageEntityBotCommand::new(
self.text.len() as u16,
command.len() as u16,
));
self.text(command)
.entity(&entity)
.expect("Failed to add bot command. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn url(self, url: impl Into<Box<str>>) -> Self {
let url = url.into();
let entity = MessageEntity::Url(MessageEntityUrl::new(
self.text.len() as u16,
url.len() as u16,
));
self.text(url)
.entity(&entity)
.expect("Failed to add URL. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn email(self, email: impl Into<Box<str>>) -> Self {
let email = email.into();
let entity = MessageEntity::Email(MessageEntityEmail::new(
self.text.len() as u16,
email.len() as u16,
));
self.text(email)
.entity(&entity)
.expect("Failed to add email. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn phone_number(self, phone_number: impl Into<Box<str>>) -> Self {
let phone_number = phone_number.into();
let entity = MessageEntity::PhoneNumber(MessageEntityPhoneNumber::new(
self.text.len() as u16,
phone_number.len() as u16,
));
self.text(phone_number)
.entity(&entity)
.expect("Failed to add phone number. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn bold(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Bold(MessageEntityBold::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add bold. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn italic(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Italic(MessageEntityItalic::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add italic. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn underline(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Underline(MessageEntityUnderline::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add underline. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn strikethrough(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Strikethrough(MessageEntityStrikethrough::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add strikethrough. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn spoiler(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Spoiler(MessageEntitySpoiler::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add spoiler. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn blockquote(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::Blockquote(MessageEntityBlockquote::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add blockquote. Report this issue to the developers")
}
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn expandable_blockquote(self, text: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::ExpandableBlockquote(MessageEntityExpandableBlockquote::new(
self.text.len() as u16,
text.len() as u16,
));
self.text(text)
.entity(&entity)
.expect("Failed to add expandable blockquote. Report this issue to the developers")
}
/// Add code as monowidth string.
/// # Arguments
/// * `code` - Code that will be added as monowidth string.
/// # Notes
/// If you want to use monowidth block, then use `pre` or `pre_language` method instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn code(self, code: impl Into<Box<str>>) -> Self {
let code = code.into();
let entity = MessageEntity::Code(MessageEntityCode::new(
self.text.len() as u16,
code.len() as u16,
));
self.text(code)
.entity(&entity)
.expect("Failed to add code. Report this issue to the developers")
}
/// Add text as monowidth string.
/// # Arguments
/// * `text` - Text that will be added as monowidth string.
/// # Notes
/// If you want to use monowidth block, then use `pre` or `pre_language` method instead.
///
/// This method is shorthand for `code` method. Using this method is the same as using `code` method,
/// but it's more readable for `text` than `code`.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn monowidth(self, text: impl Into<Box<str>>) -> Self {
self.code(text)
}
/// Add code to the monowidth block.
/// # Arguments
/// * `code` - Code that will be added to the monowidth block.
/// # Notes
/// If you want to highlight code with programming language, then use `pre_language` method instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn pre(self, code: impl Into<Box<str>>) -> Self {
let code = code.into();
let entity = MessageEntity::Pre(MessageEntityPre::new(
self.text.len() as u16,
code.len() as u16,
));
self.text(code)
.entity(&entity)
.expect("Failed to add pre. Report this issue to the developers")
}
/// Add code with programming language to the monowidth block and highlight it.
/// # Arguments
/// * `code` - Code that will be added to the monowidth block and will be highlighted.
/// * `language` - Programming language that will be used to highlight the text.
/// # Notes
/// If you want to highlight code without programming language, then use `pre` method instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn pre_language(self, code: impl Into<Box<str>>, language: impl Into<Box<str>>) -> Self {
let code = code.into();
let entity = MessageEntity::Pre(
MessageEntityPre::new(self.text.len() as u16, code.len() as u16).language(language),
);
self.text(code).entity(&entity).expect(
"Failed to add pre with programming language. Report this issue to the developers",
)
}
/// Add clickable text link.
/// # Arguments
/// * `text` - Text that will be replaced with clickable text link.
/// * `url` - URL that will be opened after user clicks on the text link.
/// # Notes
/// If you want to use link without text, then use `url` method instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn text_link(self, text: impl Into<Box<str>>, url: impl Into<Box<str>>) -> Self {
let text = text.into();
let entity = MessageEntity::TextLink(MessageEntityTextLink::new(
self.text.len() as u16,
text.len() as u16,
url,
));
self.text(text)
.entity(&entity)
.expect("Failed to add clickable text link. Report this issue to the developers")
}
/// Add mention for the user without username to the text.
/// # Arguments
/// * `text` - Text that will be added to the text and will be replaced with mention.
/// * `user` - User that will be mentioned.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn text_mention(self, text: impl Into<Box<str>>, user: User) -> Self {
let text = text.into();
let entity = MessageEntity::TextMention(MessageEntityTextMention::new(
self.text.len() as u16,
text.len() as u16,
user,
));
self.text(text).entity(&entity).expect(
"Failed to add mention for the user without username. Report this issue to the \
developers",
)
}
/// Add custom emoji to the text instead of unicode emoji.
/// # Arguments
/// * `emoji` - Emoji that will be added to the text and will be replaced with custom emoji.
/// * `custom_emoji_id` - ID of the custom emoji.
/// # Notes
/// If user doesn't have custom emoji (premium feature), then unicode emoji will be used instead.
/// # Warning
/// If the given text length is greater than [`u16::MAX`], then the text will be truncated.
#[must_use]
pub fn custom_emoji(
self,
emoji: impl Into<Box<str>>,
custom_emoji_id: impl Into<Box<str>>,
) -> Self {
let emoji = emoji.into();
let entity = MessageEntity::CustomEmoji(MessageEntityCustomEmoji::new(
self.text.len() as u16,
emoji.len() as u16,
custom_emoji_id,
));
self.text(emoji)
.entity(&entity)
.expect("Failed to add custom emoji. Report this issue to the developers")
}
/// Get formatted text.
#[must_use]
pub fn get_text(&self) -> &str {
self.text.as_str()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::utils::text::HTMLFormatter;
#[test]
fn test_text_builder() {
let builder = Builder::new(HTMLFormatter::default())
.text("Hello, ")
.bold("world")
.text("!")
.texts(["\n", "How are you?"])
.text(" ")
.italic("I'm fine")
.bold("!");
assert_eq!(
builder.get_text(),
"Hello, <b>world</b>!\nHow are you? <i>I'm fine</i><b>!</b>"
);
let builder = Builder::new(HTMLFormatter::default())
.mention("username")
.text(" ")
.hashtag("hashtag")
.text(" ")
.cashtag("cashtag")
.text(" ")
.bot_command("command")
.text(" ")
.url("https://example.com")
.text(" ")
.email("test@mail.pu")
.text(" ")
.phone_number("+1234567890")
.text(" ")
.bold("bold")
.text(" ")
.italic("italic")
.text(" ")
.underline("underline")
.text(" ")
.strikethrough("strikethrough")
.text(" ")
.spoiler("spoiler")
.text(" ")
.code("code")
.text(" ")
.pre("pre")
.text(" ")
.pre_language("pre_language", "python")
.text(" ")
.text_link("text_link", "https://example.com")
.text(" ")
.text_mention("text_mention", User::new(0, true, ""))
.text(" ")
.custom_emoji("custom_emoji", "emoji_id")
.text(" ")
.blockquote("blockquote")
.text(" ")
.expandable_blockquote("expandable_blockquote");
assert_eq!(
builder.get_text(),
"@username #hashtag $cashtag /command https://example.com test@mail.pu \
+1234567890 <b>bold</b> <i>italic</i> <u>underline</u> <s>strikethrough</s> \
<tg-spoiler>spoiler</tg-spoiler> \
<code>code</code> \
<pre>pre</pre> \
<pre><code class=\"language-python\">pre_language</code></pre> \
<a href=\"https://example.com\">text_link</a> \
<a href=\"tg://user?id=0\">text_mention</a> \
<tg-emoji data-emoji-id=\"emoji_id\">custom_emoji</tg-emoji> \
<blockquote>blockquote</blockquote> \
<blockquote expandable>expandable_blockquote</blockquote>\
"
);
}
}