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 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
//! Possible error types.
use std::io;
use thiserror::Error;
use crate::types::{ChatId, ResponseParameters, Seconds};
/// An error caused by sending a request to Telegram.
#[derive(Debug, Error)]
pub enum RequestError {
/// A Telegram API error.
#[error("A Telegram's error: {0}")]
Api(#[from] ApiError),
/// The group has been migrated to a supergroup with the specified
/// identifier.
#[error("The group has been migrated to a supergroup with ID #{0}")]
MigrateToChatId(ChatId),
/// In case of exceeding flood control, the number of seconds left to wait
/// before the request can be repeated.
#[error("Retry after {0}")]
RetryAfter(Seconds),
/// Network error while sending a request to Telegram.
#[error("A network error: {0}")]
// NOTE: this variant must not be created by anything except the explicit From impl
Network(#[source] reqwest::Error),
/// Error while parsing a response from Telegram.
///
/// If you've received this error, please, [open an issue] with the
/// description of the error.
///
/// [open an issue]: https://github.com/teloxide/teloxide/issues/new
#[error("An error while parsing JSON: {source} (raw: {raw:?})")]
InvalidJson {
#[source]
source: serde_json::Error,
/// The raw string JSON that couldn't been parsed
raw: Box<str>,
},
/// Occurs when trying to send a file to Telegram.
#[error("An I/O error: {0}")]
Io(#[from] io::Error),
}
/// An error caused by downloading a file.
#[derive(Debug, Error)]
pub enum DownloadError {
/// A network error while downloading a file from Telegram.
#[error("A network error: {0}")]
// NOTE: this variant must not be created by anything except the explicit From impl
Network(#[source] reqwest::Error),
/// An I/O error while writing a file to destination.
#[error("An I/O error: {0}")]
Io(#[from] std::io::Error),
}
pub trait AsResponseParameters {
fn response_parameters(&self) -> Option<ResponseParameters>;
fn retry_after(&self) -> Option<Seconds> {
self.response_parameters().and_then(|rp| match rp {
ResponseParameters::RetryAfter(n) => Some(n),
_ => None,
})
}
fn migrate_to_chat_id(&self) -> Option<ChatId> {
self.response_parameters().and_then(|rp| match rp {
ResponseParameters::MigrateToChatId(id) => Some(id),
_ => None,
})
}
}
impl AsResponseParameters for crate::RequestError {
fn response_parameters(&self) -> Option<ResponseParameters> {
match *self {
Self::RetryAfter(n) => Some(ResponseParameters::RetryAfter(n)),
Self::MigrateToChatId(id) => Some(ResponseParameters::MigrateToChatId(id)),
_ => None,
}
}
}
macro_rules! impl_api_error {
(
$( #[$meta:meta] )*
$vis:vis enum $ident:ident {
$(
$( #[$var_meta:meta] )*
$var_name:ident $( ($var_inner:ty) )? = $var_string:literal $(with $var_parser:expr)?
),*
}
) => {
$(#[$meta])*
#[derive(Error)]
$vis enum $ident {
$(
$(#[$var_meta])*
#[error($var_string)]
$var_name $(($var_inner))*,
)*
}
const _: () = {
struct Visitor;
impl<'de> ::serde::de::Visitor<'de> for Visitor {
type Value = $ident;
fn expecting(&self, formatter: &mut core::fmt::Formatter) -> core::fmt::Result {
formatter.write_str("telegram api error string")
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: ::serde::de::Error,
{
$(impl_api_error!(@de v, $var_name $( ($var_inner) )?, $var_string $(, $var_parser)*);)*
Err(E::unknown_variant(v, &[]))
}
}
impl<'de> ::serde::de::Deserialize<'de> for $ident {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: ::serde::de::Deserializer<'de>,
{
deserializer.deserialize_str(Visitor)
}
}
};
};
(@de $value:ident, $variant:ident, $val:literal) => {
if $value == $val {
return Ok(Self::Value::$variant)
}
};
(@de $value:ident, $variant:ident ($var_inner:ty), $val:literal, $block:expr) => {
#[allow(clippy::redundant_closure_call)]
match $block($value) {
Some(data) => return Ok(Self::Value::$variant(data)),
_ => {}
}
};
(@de $value:ident, $variant:ident, $val:literal, $block:expr) => {
#[allow(clippy::redundant_closure_call)]
if $block($value) {
return Ok(Self::Value::$variant);
}
};
}
impl_api_error! {
/// A kind of an API error.
#[derive(Debug, PartialEq, Hash, Eq, Clone)]
#[non_exhaustive]
pub enum ApiError {
/// Occurs when the bot tries to send message to user who blocked the bot.
BotBlocked = "Forbidden: bot was blocked by the user",
/// Occurs when the bot token is invalid.
// N.B. These errors are actually slightly different, "Unauthorized" is when the bot token
// is formatted mostly right, but is incorrect, whereas "Not Found" is when the url is
// not handled by TBA at all. From user POV both of those are "token is invalid", but
// there might be some cases where this is not right...
InvalidToken = "Invalid bot token" with |text: &str| text == "Unauthorized" || text == "Not Found",
/// Occurs when bot tries to modify a message without modification content.
///
/// May happen in methods:
/// 1. [`EditMessageText`]
///
/// [`EditMessageText`]: crate::payloads::EditMessageText
MessageNotModified = "Bad Request: message is not modified: specified new message content and reply markup are \
exactly the same as a current content and reply markup of the message",
/// Occurs when bot tries to forward or delete a message which was deleted.
///
/// May happen in methods:
/// 1. [`ForwardMessage`]
/// 2. [`DeleteMessage`]
///
/// [`ForwardMessage`]: crate::payloads::ForwardMessage
/// [`DeleteMessage`]: crate::payloads::DeleteMessage
MessageIdInvalid = "Bad Request: MESSAGE_ID_INVALID",
/// Occurs when bot tries to forward a message which does not exists.
///
/// May happen in methods:
/// 1. [`ForwardMessage`]
///
/// [`ForwardMessage`]: crate::payloads::ForwardMessage
MessageToForwardNotFound = "Bad Request: message to forward not found",
/// Occurs when bot tries to delete a message which does not exists.
///
/// May happen in methods:
/// 1. [`DeleteMessage`]
///
/// [`DeleteMessage`]: crate::payloads::DeleteMessage
MessageToDeleteNotFound = "Bad Request: message to delete not found",
/// Occurs when bot tries to copy a message which does not exists.
/// May happen in methods:
/// 1. [`CopyMessage`]
///
/// [`CopyMessage`]: crate::payloads::CopyMessage
MessageToCopyNotFound = "Bad Request: message to copy not found",
/// Occurs when bot tries to send a text message without text.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
MessageTextIsEmpty = "Bad Request: message text is empty",
/// Occurs when bot tries to edit a message after long time.
///
/// May happen in methods:
/// 1. [`EditMessageText`]
///
/// [`EditMessageText`]: crate::payloads::EditMessageText
MessageCantBeEdited = "Bad Request: message can't be edited",
/// Occurs when bot tries to delete a someone else's message in group where
/// it does not have enough rights.
///
/// May happen in methods:
/// 1. [`DeleteMessage`]
///
/// [`DeleteMessage`]: crate::payloads::DeleteMessage
MessageCantBeDeleted = "Bad Request: message can't be deleted",
/// Occurs when bot tries to edit a message which does not exists.
///
/// May happen in methods:
/// 1. [`EditMessageText`]
///
/// [`EditMessageText`]: crate::payloads::EditMessageText
MessageToEditNotFound = "Bad Request: message to edit not found",
/// Occurs when bot tries to reply to a message which does not exists.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
MessageToReplyNotFound = "Bad Request: reply message not found",
/// Occurs when bot tries to
MessageIdentifierNotSpecified = "Bad Request: message identifier is not specified",
/// Occurs when bot tries to send a message with text size greater then
/// 4096 symbols.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
MessageIsTooLong = "Bad Request: message is too long",
/// Occurs when bot tries to edit a message with text size greater then
/// 4096 symbols.
///
/// May happen in methods:
/// 1. [`EditMessageText`]
/// 2. [`EditMessageTextInline`]
/// 3. [`EditMessageCaption`]
/// 4. [`EditMessageCaptionInline`]
///
/// [`EditMessageText`]: crate::payloads::EditMessageText
/// [`EditMessageTextInline`]: crate::payloads::EditMessageTextInline
/// [`EditMessageCaption`]: crate::payloads::EditMessageCaption
/// [`EditMessageCaptionInline`]: crate::payloads::EditMessageCaptionInline
EditedMessageIsTooLong = "Bad Request: MESSAGE_TOO_LONG",
/// Occurs when bot tries to send media group with more than 10 items.
///
/// May happen in methods:
/// 1. [`SendMediaGroup`]
///
/// [`SendMediaGroup`]: crate::payloads::SendMediaGroup
TooMuchMessages = "Bad Request: Too much messages to send as an album",
/// Occurs when bot tries to answer an inline query with more than 50
/// results.
///
/// Consider using offsets to paginate results.
///
/// May happen in methods:
/// 1. [`AnswerInlineQuery`]
///
/// [`AnswerInlineQuery`]: crate::payloads::AnswerInlineQuery
TooMuchInlineQueryResults = "Bad Request: RESULTS_TOO_MUCH",
/// Occurs when bot tries to stop poll that has already been stopped.
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollHasAlreadyClosed = "Bad Request: poll has already been closed",
/// Occurs when bot tries to send poll with less than 2 options.
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollMustHaveMoreOptions = "Bad Request: poll must have at least 2 option",
/// Occurs when bot tries to send poll with more than 10 options.
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollCantHaveMoreOptions = "Bad Request: poll can't have more than 10 options",
/// Occurs when bot tries to send poll with empty option (without text).
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollOptionsMustBeNonEmpty = "Bad Request: poll options must be non-empty",
/// Occurs when bot tries to send poll with empty question (without text).
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollQuestionMustBeNonEmpty = "Bad Request: poll question must be non-empty",
/// Occurs when bot tries to send poll with total size of options more than
/// 100 symbols.
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollOptionsLengthTooLong = "Bad Request: poll options length must not exceed 100",
/// Occurs when bot tries to send poll with question size more than 255
/// symbols.
///
/// May happen in methods:
/// 1. [`SendPoll`]
///
/// [`SendPoll`]: crate::payloads::SendPoll
PollQuestionLengthTooLong = "Bad Request: poll question length must not exceed 255",
/// Occurs when bot tries to stop poll with message without poll.
///
/// May happen in methods:
/// 1. [`StopPoll`]
///
/// [`StopPoll`]: crate::payloads::StopPoll
MessageWithPollNotFound = "Bad Request: message with poll to stop not found",
/// Occurs when bot tries to stop poll with message without poll.
///
/// May happen in methods:
/// 1. [`StopPoll`]
///
/// [`StopPoll`]: crate::payloads::StopPoll
MessageIsNotAPoll = "Bad Request: message is not a poll",
/// Occurs when bot tries to send a message to chat in which it is not a
/// member.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
ChatNotFound = "Bad Request: chat not found",
/// Occurs when bot tries to send method with unknown user_id.
///
/// May happen in methods:
/// 1. [`getUserProfilePhotos`]
///
/// [`getUserProfilePhotos`]:
/// crate::payloads::GetUserProfilePhotos
UserNotFound = "Bad Request: user not found",
/// Occurs when bot tries to send [`SetChatDescription`] with same text as
/// in the current description.
///
/// May happen in methods:
/// 1. [`SetChatDescription`]
///
/// [`SetChatDescription`]: crate::payloads::SetChatDescription
ChatDescriptionIsNotModified = "Bad Request: chat description is not modified",
/// Occurs when bot tries to answer to query after timeout expire.
///
/// May happen in methods:
/// 1. [`AnswerCallbackQuery`]
///
/// [`AnswerCallbackQuery`]: crate::payloads::AnswerCallbackQuery
InvalidQueryId = "Bad Request: query is too old and response timeout expired or query id is invalid",
/// Occurs when bot tries to send InlineKeyboardMarkup with invalid button
/// url.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
ButtonUrlInvalid = "Bad Request: BUTTON_URL_INVALID",
/// Occurs when bot tries to send button with data size more than 64 bytes.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
ButtonDataInvalid = "Bad Request: BUTTON_DATA_INVALID",
/// Occurs when bot tries to send button with data size == 0.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
TextButtonsAreUnallowed = "Bad Request: can't parse inline keyboard button: Text buttons are unallowed in the \
inline keyboard",
/// Occurs when bot tries to get file by wrong file id.
///
/// May happen in methods:
/// 1. [`GetFile`]
///
/// [`GetFile`]: crate::payloads::GetFile
WrongFileId = "Bad Request: wrong file id",
/// Occurs when bot tries to send files with wrong file identifier or HTTP
/// url
WrongFileIdOrUrl = "Bad Request: wrong file identifier/HTTP URL specified",
/// Occurs when When sending files with an url to a site that doesn't
/// respond.
FailedToGetUrlContent = "Bad Request: failed to get HTTP URL content",
/// Occurs when bot tries to do some with group which was deactivated.
GroupDeactivated = "Bad Request: group is deactivated",
/// Occurs when image processing fails on telegram's side.
///
/// This is likely caused by an incorrectly encoded image, make sure that
/// the image is correctly encoded in a format telegram accepts.
ImageProcessFailed = "Bad Request: IMAGE_PROCESS_FAILED",
/// Occurs when bot tries to set chat photo from file ID
///
/// May happen in methods:
/// 1. [`SetChatPhoto`]
///
/// [`SetChatPhoto`]: crate::payloads::SetChatPhoto
PhotoAsInputFileRequired = "Bad Request: Photo should be uploaded as an InputFile",
/// Occurs when bot tries to add sticker to stickerset by invalid name.
///
/// May happen in methods:
/// 1. [`AddStickerToSet`]
///
/// [`AddStickerToSet`]: crate::payloads::AddStickerToSet
InvalidStickersSet = "Bad Request: STICKERSET_INVALID",
/// Occurs when bot tries to create a sticker set with a name that is
/// already used by another sticker set.
///
/// May happen in methods:
/// 1. [`CreateNewStickerSet`]
///
/// [`CreateNewStickerSet`]: crate::payloads::CreateNewStickerSet
StickerSetNameOccupied = "Bad Request: sticker set name is already occupied",
/// Occurs when bot tries to create a sticker set with user id of a bot.
///
/// May happen in methods:
/// 1. [`CreateNewStickerSet`]
///
/// [`CreateNewStickerSet`]: crate::payloads::CreateNewStickerSet
StickerSetOwnerIsBot = "Bad Request: USER_IS_BOT",
/// Occurs when bot tries to create a sticker set with invalid name.
///
/// From documentation of [`CreateNewStickerSet`]:
/// > Short name of sticker set, to be used in `t.me/addstickers/` URLs
/// (e.g., _animals_). Can contain only english letters, digits and
/// underscores. Must begin with a letter, can't contain consecutive
/// underscores and must end in “\_by\_<bot\_username>”. <bot\_username>
/// is case insensitive. 1-64 characters.
///
/// May happen in methods:
/// 1. [`CreateNewStickerSet`]
///
/// [`CreateNewStickerSet`]: crate::payloads::CreateNewStickerSet
InvalidStickerName = "Bad Request: invalid sticker set name is specified",
/// Occurs when bot tries to pin a message without rights to pin in this
/// chat.
///
/// May happen in methods:
/// 1. [`PinChatMessage`]
///
/// [`PinChatMessage`]: crate::payloads::PinChatMessage
NotEnoughRightsToPinMessage = "Bad Request: not enough rights to pin a message",
/// Occurs when bot tries to pin or unpin a message without rights to pin
/// in this chat.
///
/// May happen in methods:
/// 1. [`PinChatMessage`]
/// 2. [`UnpinChatMessage`]
///
/// [`PinChatMessage`]: crate::payloads::PinChatMessage
/// [`UnpinChatMessage`]: crate::payloads::UnpinChatMessage
NotEnoughRightsToManagePins = "Bad Request: not enough rights to manage pinned messages in the chat",
/// Occurs when bot tries change default chat permissions without "Ban
/// Users" permission in this chat.
///
/// May happen in methods:
/// 1. [`SetChatPermissions`]
///
/// [`SetChatPermissions`]: crate::payloads::SetChatPermissions
NotEnoughRightsToChangeChatPermissions = "Bad Request: not enough rights to change chat permissions",
/// Occurs when bot tries to use method in group which is allowed only in a
/// supergroup or channel.
MethodNotAvailableInPrivateChats = "Bad Request: method is available only for supergroups and channel",
/// Occurs when bot tries to demote chat creator.
///
/// May happen in methods:
/// 1. [`PromoteChatMember`]
///
/// [`PromoteChatMember`]: crate::payloads::PromoteChatMember
CantDemoteChatCreator = "Bad Request: can't demote chat creator",
/// Occurs when bot tries to restrict self in group chats.
///
/// May happen in methods:
/// 1. [`RestrictChatMember`]
///
/// [`RestrictChatMember`]: crate::payloads::RestrictChatMember
CantRestrictSelf = "Bad Request: can't restrict self",
/// Occurs when bot tries to restrict chat member without rights to
/// restrict in this chat.
///
/// May happen in methods:
/// 1. [`RestrictChatMember`]
///
/// [`RestrictChatMember`]: crate::payloads::RestrictChatMember
NotEnoughRightsToRestrict = "Bad Request: not enough rights to restrict/unrestrict chat member",
/// Occurs when bot tries to post a message in a channel without "Post
/// Messages" admin right.
NotEnoughRightsToPostMessages = "Bad Request: need administrator rights in the channel chat",
/// Occurs when bot tries set webhook to protocol other than HTTPS.
///
/// May happen in methods:
/// 1. [`SetWebhook`]
///
/// [`SetWebhook`]: crate::payloads::SetWebhook
WebhookRequireHttps = "Bad Request: bad webhook: HTTPS url must be provided for webhook",
/// Occurs when bot tries to set webhook to port other than 80, 88, 443 or
/// 8443.
///
/// May happen in methods:
/// 1. [`SetWebhook`]
///
/// [`SetWebhook`]: crate::payloads::SetWebhook
BadWebhookPort = "Bad Request: bad webhook: Webhook can be set up only on ports 80, 88, 443 or 8443",
/// Occurs when bot tries to set webhook to unknown host.
///
/// May happen in methods:
/// 1. [`SetWebhook`]
///
/// [`SetWebhook`]: crate::payloads::SetWebhook
UnknownHost = "Bad Request: bad webhook: Failed to resolve host: Name or service not known",
/// Occurs when bot tries to set webhook to invalid URL.
///
/// May happen in methods:
/// 1. [`SetWebhook`]
///
/// [`SetWebhook`]: crate::payloads::SetWebhook
CantParseUrl = "Bad Request: can't parse URL",
/// Occurs when bot tries to send message with unfinished entities.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
CantParseEntities(String) = "{0}" with |text: &str| {
if text.starts_with("Bad Request: can't parse entities") {
Some(text.to_owned())
} else {
None
}
},
/// Occurs when bot tries to use getUpdates while webhook is active.
///
/// May happen in methods:
/// 1. [`GetUpdates`]
///
/// [`GetUpdates`]: crate::payloads::GetUpdates
CantGetUpdates = "can't use getUpdates method while webhook is active",
/// Occurs when bot tries to do some in group where bot was kicked.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
BotKicked = "Unauthorized: bot was kicked from a chat",
/// Occurs when bot tries to do something in a supergroup the bot was
/// kicked from.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
BotKickedFromSupergroup = "Forbidden: bot was kicked from the supergroup chat",
/// Occurs when bot tries to send a message to a deactivated user (i.e. a
/// user that was banned by telegram).
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
UserDeactivated = "Forbidden: user is deactivated",
/// Occurs when you tries to initiate conversation with a user.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
CantInitiateConversation = "Unauthorized: bot can't initiate conversation with a user",
/// Occurs when you tries to send message to bot.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
CantTalkWithBots = "Unauthorized: bot can't send messages to bots",
/// Occurs when bot tries to send button with invalid http url.
///
/// May happen in methods:
/// 1. [`SendMessage`]
///
/// [`SendMessage`]: crate::payloads::SendMessage
WrongHttpUrl = "Bad Request: wrong HTTP URL",
/// Occurs when multiple [`GetUpdates`] calls happen at the same time.
///
/// This can happen if
/// 1. You are running multiple bot instances
/// 2. You are running multiple update consumers (like `Dispatcher` or `repl`)
/// 3. You are calling [`GetUpdates`] yourself and the second call is done before the first one finishes
///
/// May happen in methods:
/// 1. [`GetUpdates`]
///
/// [`GetUpdates`]: crate::payloads::GetUpdates
TerminatedByOtherGetUpdates = "Conflict: terminated by other getUpdates request; make sure that only one bot instance \
is running",
/// Occurs when bot tries to get file by invalid file id.
///
/// May happen in methods:
/// 1. [`GetFile`]
///
/// [`GetFile`]: crate::payloads::GetFile
FileIdInvalid = "Bad Request: invalid file id",
/// Occurs when bot tries to upload a file which is larger than 50 MB using
/// multipart/form-data.
///
/// May happen in methods:
/// 1. [`SendVideo`]
/// 2. [`SendDocument`]
///
/// [`SendVideo`]: crate::payloads::SendVideo
/// [`SendDocument`]: crate::payloads::SendDocument
RequestEntityTooLarge = "Request Entity Too Large",
/// Error which is not known to `teloxide`.
///
/// If you've received this error, please [open an issue] with the
/// description of the error.
///
/// [open an issue]: https://github.com/teloxide/teloxide/issues/new
Unknown(String) = "Unknown error: {0:?}" with |text: &str| Some(text.to_owned())
}
}
/// This impl allows to use `?` to propagate [`DownloadError`]s in function
/// returning [`RequestError`]s. For example:
///
/// ```rust
/// # use teloxide_core::errors::{DownloadError, RequestError};
///
/// async fn handler() -> Result<(), RequestError> {
/// download_file().await?; // `?` just works
///
/// Ok(())
/// }
///
/// async fn download_file() -> Result<(), DownloadError> {
/// /* download file here */
/// Ok(())
/// }
/// ```
impl From<DownloadError> for RequestError {
fn from(download_err: DownloadError) -> Self {
match download_err {
DownloadError::Network(err) => RequestError::Network(err),
DownloadError::Io(err) => RequestError::Io(err),
}
}
}
impl From<reqwest::Error> for DownloadError {
fn from(error: reqwest::Error) -> Self {
DownloadError::Network(hide_token(error))
}
}
impl From<reqwest::Error> for RequestError {
fn from(error: reqwest::Error) -> Self {
RequestError::Network(hide_token(error))
}
}
/// Replaces token in the url in the error with `token:redacted` string.
pub(crate) fn hide_token(mut error: reqwest::Error) -> reqwest::Error {
let url = match error.url_mut() {
Some(url) => url,
None => return error,
};
if let Some(mut segments) = url.path_segments() {
// Usually the url looks like "bot<token>/..." or "file/bot<token>/...".
let (beginning, segment) = match segments.next() {
Some("file") => ("file/", segments.next()),
segment => ("", segment),
};
if let Some(token) = segment.and_then(|s| s.strip_prefix("bot")) {
// make sure that what we are about to delete looks like a bot token
if let Some((id, secret)) = token.split_once(':') {
// The part before the : in the token is the id of the bot.
let id_character = |c: char| c.is_ascii_digit();
// The part after the : in the token is the secret.
//
// In all bot tokens we could find the secret is 35 characters long and is
// 0-9a-zA-Z_- only.
//
// It would be nice to research if TBA always has 35 character secrets or if it
// is just a coincidence.
const SECRET_LENGTH: usize = 35;
let secret_character = |c: char| c.is_ascii_alphanumeric() || c == '-' || c == '_';
if secret.len() >= SECRET_LENGTH
&& id.chars().all(id_character)
&& secret.chars().all(secret_character)
{
// found token, hide only the token
let without_token =
&url.path()[(beginning.len() + "/bot".len() + token.len())..];
let redacted = format!("{beginning}token:redacted{without_token}");
url.set_path(&redacted);
return error;
}
}
}
}
// couldn't find token in the url, hide the whole url
error.without_url()
}
#[cfg(test)]
mod tests {
#[test]
fn custom_result() {
use super::ApiError;
use serde::Deserialize;
let cases = &[
("{\"data\": \"Forbidden: bot was blocked by the user\"}", ApiError::BotBlocked),
("{\"data\": \"Unauthorized\"}", ApiError::InvalidToken),
("{\"data\": \"Not Found\"}", ApiError::InvalidToken),
(
"{\"data\": \"Bad Request: message is not modified: specified new message content \
and reply markup are exactly the same as a current content and reply markup of \
the message\"}",
ApiError::MessageNotModified,
),
("{\"data\": \"Bad Request: MESSAGE_ID_INVALID\"}", ApiError::MessageIdInvalid),
(
"{\"data\": \"Bad Request: message to forward not found\"}",
ApiError::MessageToForwardNotFound,
),
(
"{\"data\": \"Bad Request: message to delete not found\"}",
ApiError::MessageToDeleteNotFound,
),
(
"{\"data\": \"Bad Request: message to copy not found\"}",
ApiError::MessageToCopyNotFound,
),
("{\"data\": \"Bad Request: message text is empty\"}", ApiError::MessageTextIsEmpty),
("{\"data\": \"Bad Request: message can't be edited\"}", ApiError::MessageCantBeEdited),
(
"{\"data\": \"Bad Request: message can't be deleted\"}",
ApiError::MessageCantBeDeleted,
),
(
"{\"data\": \"Bad Request: message to edit not found\"}",
ApiError::MessageToEditNotFound,
),
(
"{\"data\": \"Bad Request: reply message not found\"}",
ApiError::MessageToReplyNotFound,
),
(
"{\"data\": \"Bad Request: message identifier is not specified\"}",
ApiError::MessageIdentifierNotSpecified,
),
("{\"data\": \"Bad Request: message is too long\"}", ApiError::MessageIsTooLong),
("{\"data\": \"Bad Request: MESSAGE_TOO_LONG\"}", ApiError::EditedMessageIsTooLong),
(
"{\"data\": \"Bad Request: Too much messages to send as an album\"}",
ApiError::TooMuchMessages,
),
("{\"data\": \"Bad Request: RESULTS_TOO_MUCH\"}", ApiError::TooMuchInlineQueryResults),
(
"{\"data\": \"Bad Request: poll has already been closed\"}",
ApiError::PollHasAlreadyClosed,
),
(
"{\"data\": \"Bad Request: poll must have at least 2 option\"}",
ApiError::PollMustHaveMoreOptions,
),
(
"{\"data\": \"Bad Request: poll can't have more than 10 options\"}",
ApiError::PollCantHaveMoreOptions,
),
(
"{\"data\": \"Bad Request: poll options must be non-empty\"}",
ApiError::PollOptionsMustBeNonEmpty,
),
(
"{\"data\": \"Bad Request: poll question must be non-empty\"}",
ApiError::PollQuestionMustBeNonEmpty,
),
(
"{\"data\": \"Bad Request: poll options length must not exceed 100\"}",
ApiError::PollOptionsLengthTooLong,
),
(
"{\"data\": \"Bad Request: poll question length must not exceed 255\"}",
ApiError::PollQuestionLengthTooLong,
),
(
"{\"data\": \"Bad Request: message with poll to stop not found\"}",
ApiError::MessageWithPollNotFound,
),
("{\"data\": \"Bad Request: message is not a poll\"}", ApiError::MessageIsNotAPoll),
("{\"data\": \"Bad Request: chat not found\"}", ApiError::ChatNotFound),
("{\"data\": \"Bad Request: user not found\"}", ApiError::UserNotFound),
(
"{\"data\": \"Bad Request: chat description is not modified\"}",
ApiError::ChatDescriptionIsNotModified,
),
(
"{\"data\": \"Bad Request: query is too old and response timeout expired or query \
id is invalid\"}",
ApiError::InvalidQueryId,
),
("{\"data\": \"Bad Request: BUTTON_URL_INVALID\"}", ApiError::ButtonUrlInvalid),
("{\"data\": \"Bad Request: BUTTON_DATA_INVALID\"}", ApiError::ButtonDataInvalid),
(
"{\"data\": \"Bad Request: can't parse inline keyboard button: Text buttons are \
unallowed in the inline keyboard\"}",
ApiError::TextButtonsAreUnallowed,
),
("{\"data\": \"Bad Request: wrong file id\"}", ApiError::WrongFileId),
(
"{\"data\": \"Bad Request: wrong file identifier/HTTP URL specified\"}",
ApiError::WrongFileIdOrUrl,
),
(
"{\"data\": \"Bad Request: failed to get HTTP URL content\"}",
ApiError::FailedToGetUrlContent,
),
("{\"data\": \"Bad Request: group is deactivated\"}", ApiError::GroupDeactivated),
("{\"data\": \"Bad Request: IMAGE_PROCESS_FAILED\"}", ApiError::ImageProcessFailed),
(
"{\"data\": \"Bad Request: Photo should be uploaded as an InputFile\"}",
ApiError::PhotoAsInputFileRequired,
),
("{\"data\": \"Bad Request: STICKERSET_INVALID\"}", ApiError::InvalidStickersSet),
(
"{\"data\": \"Bad Request: sticker set name is already occupied\"}",
ApiError::StickerSetNameOccupied,
),
("{\"data\": \"Bad Request: USER_IS_BOT\"}", ApiError::StickerSetOwnerIsBot),
(
"{\"data\": \"Bad Request: invalid sticker set name is specified\"}",
ApiError::InvalidStickerName,
),
(
"{\"data\": \"Bad Request: not enough rights to pin a message\"}",
ApiError::NotEnoughRightsToPinMessage,
),
(
"{\"data\": \"Bad Request: not enough rights to manage pinned messages in the \
chat\"}",
ApiError::NotEnoughRightsToManagePins,
),
(
"{\"data\": \"Bad Request: not enough rights to change chat permissions\"}",
ApiError::NotEnoughRightsToChangeChatPermissions,
),
(
"{\"data\": \"Bad Request: method is available only for supergroups and channel\"}",
ApiError::MethodNotAvailableInPrivateChats,
),
(
"{\"data\": \"Bad Request: can't demote chat creator\"}",
ApiError::CantDemoteChatCreator,
),
("{\"data\": \"Bad Request: can't restrict self\"}", ApiError::CantRestrictSelf),
(
"{\"data\": \"Bad Request: not enough rights to restrict/unrestrict chat member\"}",
ApiError::NotEnoughRightsToRestrict,
),
(
"{\"data\": \"Bad Request: need administrator rights in the channel chat\"}",
ApiError::NotEnoughRightsToPostMessages,
),
(
"{\"data\": \"Bad Request: bad webhook: HTTPS url must be provided for webhook\"}",
ApiError::WebhookRequireHttps,
),
(
"{\"data\": \"Bad Request: bad webhook: Webhook can be set up only on ports 80, \
88, 443 or 8443\"}",
ApiError::BadWebhookPort,
),
(
"{\"data\": \"Bad Request: bad webhook: Failed to resolve host: Name or service \
not known\"}",
ApiError::UnknownHost,
),
("{\"data\": \"Bad Request: can't parse URL\"}", ApiError::CantParseUrl),
(
"{\"data\": \"Bad Request: can't parse entities: SomeRandomString\"}",
ApiError::CantParseEntities(
"Bad Request: can't parse entities: SomeRandomString".to_owned(),
),
),
(
"{\"data\": \"can't use getUpdates method while webhook is active\"}",
ApiError::CantGetUpdates,
),
("{\"data\": \"Unauthorized: bot was kicked from a chat\"}", ApiError::BotKicked),
(
"{\"data\": \"Forbidden: bot was kicked from the supergroup chat\"}",
ApiError::BotKickedFromSupergroup,
),
("{\"data\": \"Forbidden: user is deactivated\"}", ApiError::UserDeactivated),
(
"{\"data\": \"Unauthorized: bot can't initiate conversation with a user\"}",
ApiError::CantInitiateConversation,
),
(
"{\"data\": \"Unauthorized: bot can't send messages to bots\"}",
ApiError::CantTalkWithBots,
),
("{\"data\": \"Bad Request: wrong HTTP URL\"}", ApiError::WrongHttpUrl),
(
"{\"data\": \"Conflict: terminated by other getUpdates request; make sure that \
only one bot instance is running\"}",
ApiError::TerminatedByOtherGetUpdates,
),
("{\"data\": \"Bad Request: invalid file id\"}", ApiError::FileIdInvalid),
("{\"data\": \"Request Entity Too Large\"}", ApiError::RequestEntityTooLarge),
("{\"data\": \"RandomError\"}", ApiError::Unknown("RandomError".to_string())),
];
#[derive(Deserialize, Debug)]
struct Res<T> {
data: T,
}
for (data, expected) in cases {
let raw = serde_json::from_str::<Res<String>>(data).unwrap().data;
let parsed = serde_json::from_str::<Res<ApiError>>(data).unwrap().data;
assert_eq!(&parsed, expected);
let expected_error_message = match parsed {
ApiError::Unknown(_) => {
format!("Unknown error: \"{raw}\"")
}
ApiError::InvalidToken => "Invalid bot token".to_owned(),
_ => raw,
};
assert_eq!(parsed.to_string(), expected_error_message);
}
}
}