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 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
use std::iter;
use serde::Serialize;
use crate::types::{InputFile, MessageEntity, ParseMode};
/// This object represents the content of a media message to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmedia).
#[derive(Clone, Debug, Serialize)]
#[serde(tag = "type")]
#[serde(rename_all = "snake_case")]
pub enum InputMedia {
Photo(InputMediaPhoto),
Video(InputMediaVideo),
Animation(InputMediaAnimation),
Audio(InputMediaAudio),
Document(InputMediaDocument),
}
/// Represents a photo to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmediaphoto).
#[serde_with_macros::skip_serializing_none]
#[derive(Clone, Debug, Serialize)]
pub struct InputMediaPhoto {
/// File to send.
pub media: InputFile,
/// Caption of the photo to be sent, 0-1024 characters.
pub caption: Option<String>,
/// Send [Markdown] or [HTML], if you want Telegram apps to show [bold,
/// italic, fixed-width text or inline URLs] in the media caption.
///
/// [Markdown]: https://core.telegram.org/bots/api#markdown-style
/// [HTML]: https://core.telegram.org/bots/api#html-style
/// [bold, italic, fixed-width text or inline URLs]: https://core.telegram.org/bots/api#formatting-options
pub parse_mode: Option<ParseMode>,
/// List of special entities that appear in the caption, which can be
/// specified instead of `parse_mode`.
pub caption_entities: Option<Vec<MessageEntity>>,
/// Pass `true` if the photo needs to be covered with a spoiler animation.
#[serde(skip_serializing_if = "std::ops::Not::not")]
pub has_spoiler: bool,
}
impl InputMediaPhoto {
pub const fn new(media: InputFile) -> Self {
Self { media, caption: None, parse_mode: None, caption_entities: None, has_spoiler: false }
}
pub fn media(mut self, val: InputFile) -> Self {
self.media = val;
self
}
pub fn caption<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.caption = Some(val.into());
self
}
pub const fn parse_mode(mut self, val: ParseMode) -> Self {
self.parse_mode = Some(val);
self
}
pub fn caption_entities<C>(mut self, val: C) -> Self
where
C: IntoIterator<Item = MessageEntity>,
{
self.caption_entities = Some(val.into_iter().collect());
self
}
/// Sets [`has_spoiler`] to `true`.
///
/// [`has_spoiler`]: InputMediaPhoto::has_spoiler
pub fn spoiler(mut self) -> Self {
self.has_spoiler = true;
self
}
}
/// Represents a video to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmediavideo).
#[serde_with_macros::skip_serializing_none]
#[derive(Clone, Debug, Serialize)]
pub struct InputMediaVideo {
// File to send.
pub media: InputFile,
/// Thumbnail of the file sent; can be ignored if thumbnail generation
/// for the file is supported server-side. The thumbnail should be in
/// JPEG format and less than 200 kB in size. A thumbnail‘s width and
/// height should not exceed 320. Ignored if the file is not uploaded
/// using multipart/form-data.
pub thumb: Option<InputFile>,
/// Caption of the video to be sent, 0-1024 characters.
pub caption: Option<String>,
/// Send [Markdown] or [HTML], if you want Telegram apps to show [bold,
/// italic, fixed-width text or inline URLs] in the media caption.
///
/// [Markdown]: https://core.telegram.org/bots/api#markdown-style
/// [HTML]: https://core.telegram.org/bots/api#html-style
/// [bold, italic, fixed-width text or inline URLs]: https://core.telegram.org/bots/api#formatting-options
pub parse_mode: Option<ParseMode>,
/// List of special entities that appear in the caption, which can be
/// specified instead of `parse_mode`.
pub caption_entities: Option<Vec<MessageEntity>>,
/// Video width.
pub width: Option<u16>,
/// Video height.
pub height: Option<u16>,
/// Video duration.
pub duration: Option<u16>,
/// Pass `true`, if the uploaded video is suitable for streaming.
pub supports_streaming: Option<bool>,
/// Pass `true` if the video needs to be covered with a spoiler animation.
#[serde(skip_serializing_if = "std::ops::Not::not")]
pub has_spoiler: bool,
}
impl InputMediaVideo {
pub const fn new(media: InputFile) -> Self {
Self {
media,
thumb: None,
caption: None,
parse_mode: None,
caption_entities: None,
width: None,
height: None,
duration: None,
supports_streaming: None,
has_spoiler: false,
}
}
pub fn media(mut self, val: InputFile) -> Self {
self.media = val;
self
}
pub fn thumb(mut self, val: InputFile) -> Self {
self.thumb = Some(val);
self
}
pub fn caption<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.caption = Some(val.into());
self
}
pub const fn parse_mode(mut self, val: ParseMode) -> Self {
self.parse_mode = Some(val);
self
}
pub fn caption_entities<C>(mut self, val: C) -> Self
where
C: IntoIterator<Item = MessageEntity>,
{
self.caption_entities = Some(val.into_iter().collect());
self
}
pub const fn width(mut self, val: u16) -> Self {
self.width = Some(val);
self
}
pub const fn height(mut self, val: u16) -> Self {
self.height = Some(val);
self
}
pub const fn duration(mut self, val: u16) -> Self {
self.duration = Some(val);
self
}
pub const fn supports_streaming(mut self, val: bool) -> Self {
self.supports_streaming = Some(val);
self
}
/// Sets [`has_spoiler`] to `true`.
///
/// [`has_spoiler`]: InputMediaVideo::has_spoiler
pub fn spoiler(mut self) -> Self {
self.has_spoiler = true;
self
}
}
/// Represents an animation file (GIF or H.264/MPEG-4 AVC video without
/// sound) to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmediaanimation).
#[serde_with_macros::skip_serializing_none]
#[derive(Clone, Debug, Serialize)]
pub struct InputMediaAnimation {
/// File to send.
pub media: InputFile,
/// Thumbnail of the file sent; can be ignored if thumbnail generation
/// for the file is supported server-side. The thumbnail should be in
/// JPEG format and less than 200 kB in size. A thumbnail‘s width and
/// height should not exceed 320. Ignored if the file is not uploaded
/// using multipart/form-data.
pub thumb: Option<InputFile>,
/// Caption of the animation to be sent, 0-1024 characters.
pub caption: Option<String>,
/// Send [Markdown] or [HTML], if you want Telegram apps to show [bold,
/// italic, fixed-width text or inline URLs] in the media caption.
///
/// [Markdown]: https://core.telegram.org/bots/api#markdown-style
/// [HTML]: https://core.telegram.org/bots/api#html-style
/// [bold, italic, fixed-width text or inline URLs]: https://core.telegram.org/bots/api#formatting-options
pub parse_mode: Option<ParseMode>,
/// List of special entities that appear in the caption, which can be
/// specified instead of `parse_mode`.
pub caption_entities: Option<Vec<MessageEntity>>,
/// Animation width.
pub width: Option<u16>,
/// Animation height.
pub height: Option<u16>,
/// Animation duration.
pub duration: Option<u16>,
/// Pass `true` if the animation needs to be covered with a spoiler
/// animation.
#[serde(skip_serializing_if = "std::ops::Not::not")]
pub has_spoiler: bool,
}
impl InputMediaAnimation {
pub const fn new(media: InputFile) -> Self {
Self {
media,
thumb: None,
caption: None,
parse_mode: None,
width: None,
height: None,
duration: None,
caption_entities: None,
has_spoiler: false,
}
}
pub fn media(mut self, val: InputFile) -> Self {
self.media = val;
self
}
pub fn thumb(mut self, val: InputFile) -> Self {
self.thumb = Some(val);
self
}
pub fn caption<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.caption = Some(val.into());
self
}
pub const fn parse_mode(mut self, val: ParseMode) -> Self {
self.parse_mode = Some(val);
self
}
pub fn caption_entities<C>(mut self, val: C) -> Self
where
C: IntoIterator<Item = MessageEntity>,
{
self.caption_entities = Some(val.into_iter().collect());
self
}
pub const fn width(mut self, val: u16) -> Self {
self.width = Some(val);
self
}
pub const fn height(mut self, val: u16) -> Self {
self.height = Some(val);
self
}
pub const fn duration(mut self, val: u16) -> Self {
self.duration = Some(val);
self
}
/// Sets [`has_spoiler`] to `true`.
///
/// [`has_spoiler`]: InputMediaAnimation::has_spoiler
pub fn spoiler(mut self) -> Self {
self.has_spoiler = true;
self
}
}
/// Represents an audio file to be treated as music to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmediaaudio).
#[serde_with_macros::skip_serializing_none]
#[derive(Clone, Debug, Serialize)]
pub struct InputMediaAudio {
/// File to send.
pub media: InputFile,
/// Thumbnail of the file sent; can be ignored if thumbnail generation
/// for the file is supported server-side. The thumbnail should be in
/// JPEG format and less than 200 kB in size. A thumbnail‘s width and
/// height should not exceed 320. Ignored if the file is not uploaded
/// using multipart/form-data.
pub thumb: Option<InputFile>,
/// Caption of the audio to be sent, 0-1024 characters.
pub caption: Option<String>,
/// Send [Markdown] or [HTML], if you want Telegram apps to show [bold,
/// italic, fixed-width text or inline URLs] in the media caption.
///
/// [Markdown]: https://core.telegram.org/bots/api#markdown-style
/// [HTML]: https://core.telegram.org/bots/api#html-style
/// [bold, italic, fixed-width text or inline URLs]: https://core.telegram.org/bots/api#formatting-options
pub parse_mode: Option<ParseMode>,
/// List of special entities that appear in the caption, which can be
/// specified instead of `parse_mode`.
pub caption_entities: Option<Vec<MessageEntity>>,
/// Duration of the audio in seconds.
pub duration: Option<u16>,
/// Performer of the audio.
pub performer: Option<String>,
/// Title of the audio.
pub title: Option<String>,
}
impl InputMediaAudio {
pub const fn new(media: InputFile) -> Self {
Self {
media,
thumb: None,
caption: None,
parse_mode: None,
performer: None,
title: None,
duration: None,
caption_entities: None,
}
}
pub fn media(mut self, val: InputFile) -> Self {
self.media = val;
self
}
pub fn thumb(mut self, val: InputFile) -> Self {
self.thumb = Some(val);
self
}
pub fn caption<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.caption = Some(val.into());
self
}
pub const fn parse_mode(mut self, val: ParseMode) -> Self {
self.parse_mode = Some(val);
self
}
pub fn caption_entities<C>(mut self, val: C) -> Self
where
C: IntoIterator<Item = MessageEntity>,
{
self.caption_entities = Some(val.into_iter().collect());
self
}
pub const fn duration(mut self, val: u16) -> Self {
self.duration = Some(val);
self
}
pub fn performer<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.performer = Some(val.into());
self
}
pub fn title<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.title = Some(val.into());
self
}
}
/// Represents a general file to be sent.
///
/// [The official docs](https://core.telegram.org/bots/api#inputmediadocument).
#[serde_with_macros::skip_serializing_none]
#[derive(Clone, Debug, Serialize)]
pub struct InputMediaDocument {
/// File to send.
pub media: InputFile,
/// Thumbnail of the file sent; can be ignored if thumbnail generation
/// for the file is supported server-side. The thumbnail should be in
/// JPEG format and less than 200 kB in size. A thumbnail‘s width and
/// height should not exceed 320. Ignored if the file is not uploaded
/// using multipart/form-data.
pub thumb: Option<InputFile>,
/// Caption of the document to be sent, 0-1024 charactersю
pub caption: Option<String>,
/// Send [Markdown] or [HTML], if you want Telegram apps to show [bold,
/// italic, fixed-width text or inline URLs] in the media caption.
///
/// [Markdown]: https://core.telegram.org/bots/api#markdown-style
/// [HTML]: https://core.telegram.org/bots/api#html-style
/// [bold, italic, fixed-width text or inline URLs]: https://core.telegram.org/bots/api#formatting-options
pub parse_mode: Option<ParseMode>,
/// List of special entities that appear in the caption, which can be
/// specified instead of `parse_mode`.
pub caption_entities: Option<Vec<MessageEntity>>,
/// Disables automatic server-side content type detection for files uploaded
/// using multipart/form-data. Always true, if the document is sent as part
/// of an album.
pub disable_content_type_detection: Option<bool>,
}
impl InputMediaDocument {
pub const fn new(media: InputFile) -> Self {
Self {
media,
thumb: None,
caption: None,
parse_mode: None,
disable_content_type_detection: None,
caption_entities: None,
}
}
pub fn media(mut self, val: InputFile) -> Self {
self.media = val;
self
}
pub fn thumb(mut self, val: InputFile) -> Self {
self.thumb = Some(val);
self
}
pub fn caption<S>(mut self, val: S) -> Self
where
S: Into<String>,
{
self.caption = Some(val.into());
self
}
pub const fn parse_mode(mut self, val: ParseMode) -> Self {
self.parse_mode = Some(val);
self
}
pub fn caption_entities<C>(mut self, val: C) -> Self
where
C: IntoIterator<Item = MessageEntity>,
{
self.caption_entities = Some(val.into_iter().collect());
self
}
}
impl From<InputMedia> for InputFile {
fn from(media: InputMedia) -> InputFile {
match media {
InputMedia::Photo(InputMediaPhoto { media, .. })
| InputMedia::Document(InputMediaDocument { media, .. })
| InputMedia::Audio(InputMediaAudio { media, .. })
| InputMedia::Animation(InputMediaAnimation { media, .. })
| InputMedia::Video(InputMediaVideo { media, .. }) => media,
}
}
}
impl InputMedia {
/// Returns an iterator of all files in this input media
pub(crate) fn files(&self) -> impl Iterator<Item = &InputFile> {
use InputMedia::*;
let (media, thumb) = match self {
Photo(InputMediaPhoto { media, .. }) => (media, None),
Document(InputMediaDocument { media, thumb, .. })
| Audio(InputMediaAudio { media, thumb, .. })
| Animation(InputMediaAnimation { media, thumb, .. })
| Video(InputMediaVideo { media, thumb, .. }) => (media, thumb.as_ref()),
};
iter::once(media).chain(thumb)
}
/// Returns an iterator of all files in this input media
pub(crate) fn files_mut(&mut self) -> impl Iterator<Item = &mut InputFile> {
use InputMedia::*;
let (media, thumb) = match self {
Photo(InputMediaPhoto { media, .. }) => (media, None),
Document(InputMediaDocument { media, thumb, .. })
| Audio(InputMediaAudio { media, thumb, .. })
| Animation(InputMediaAnimation { media, thumb, .. })
| Video(InputMediaVideo { media, thumb, .. }) => (media, thumb.as_mut()),
};
iter::once(media).chain(thumb)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn photo_serialize() {
let expected_json = r#"{"type":"photo","media":"123456"}"#;
let photo = InputMedia::Photo(InputMediaPhoto {
media: InputFile::file_id("123456"),
caption: None,
parse_mode: None,
caption_entities: None,
has_spoiler: false,
});
let actual_json = serde_json::to_string(&photo).unwrap();
assert_eq!(expected_json, actual_json);
}
#[test]
fn video_serialize() {
let expected_json = r#"{"type":"video","media":"123456"}"#;
let video = InputMedia::Video(InputMediaVideo {
media: InputFile::file_id("123456"),
thumb: None,
caption: None,
parse_mode: None,
width: None,
height: None,
duration: None,
supports_streaming: None,
caption_entities: None,
has_spoiler: false,
});
let actual_json = serde_json::to_string(&video).unwrap();
assert_eq!(expected_json, actual_json);
}
#[test]
fn animation_serialize() {
let expected_json = r#"{"type":"animation","media":"123456"}"#;
let video = InputMedia::Animation(InputMediaAnimation {
media: InputFile::file_id("123456"),
thumb: None,
caption: None,
parse_mode: None,
width: None,
height: None,
duration: None,
caption_entities: None,
has_spoiler: false,
});
let actual_json = serde_json::to_string(&video).unwrap();
assert_eq!(expected_json, actual_json);
}
#[test]
fn audio_serialize() {
let expected_json = r#"{"type":"audio","media":"123456"}"#;
let video = InputMedia::Audio(InputMediaAudio {
media: InputFile::file_id("123456"),
thumb: None,
caption: None,
parse_mode: None,
duration: None,
performer: None,
title: None,
caption_entities: None,
});
let actual_json = serde_json::to_string(&video).unwrap();
assert_eq!(expected_json, actual_json);
}
#[test]
fn document_serialize() {
let expected_json = r#"{"type":"document","media":"123456"}"#;
let video = InputMedia::Document(InputMediaDocument {
media: InputFile::file_id("123456"),
thumb: None,
caption: None,
parse_mode: None,
caption_entities: None,
disable_content_type_detection: None,
});
let actual_json = serde_json::to_string(&video).unwrap();
assert_eq!(expected_json, actual_json);
}
}