tbot/
methods.rs

1//! Structs for calling API methods.
2//!
3//! The methods from this module can't be constructed directly; instead, you
4//! construct them using a [`Bot`] instance which infers the underlying client
5//! and your bot's token, or using [contexts] that infer even more information
6//! from the update, such as the chat ID.
7//!
8//! All the methods have a common pattern:
9//!
10//! - Methods provide Builder API for optional parameters;
11//! - Methods have the asynchronous `call` method, which calls the method
12//!   and resolves with a `Result`.
13//!
14//! For example, here's how to call [`SendMessage`]:
15//!
16//! ```no_run
17//! # async fn foo() {
18//! use tbot::types::{chat, parameters::Text};
19//!
20//! const CHAT: chat::Id = chat::Id(0);
21//! const MESSAGE: &str = "`tbot` is a super-cool crate!";
22//!
23//! let bot = tbot::from_env!("BOT_TOKEN");
24//! bot.send_message(CHAT, Text::markdown(MESSAGE)).call().await.unwrap();
25//! # }
26//! ```
27//!
28//! # Inline/message methods
29//!
30//! Several API methods accept either (`chat_id` and `message_id`) or
31//! `inline_message_id`, and their return type depends on the chosen
32//! parameters. For such methods, `tbot` provides two structs, e.g. for
33//! [`editMessageText`][tg-doc] there are [`EditMessageText`] which resolves to
34//! [`types::Message`] and [`EditInlineText`] which resolves to `()`. This
35//! brings a type-safer API wrapper, unlike if we only had one method
36//! which would resolve to `(() | types::Message)`.
37//!
38//! [`Bot`]: ../struct.Bot.html
39//! [contexts]: ../contexts/
40//! [`SendMessage`]: ./struct.SendMessage.html
41//! [tg-doc]: https://core.telegram.org/bots/api#editmessagetext
42//! [`EditMessageText`]: ./struct.EditMessageText.html
43//! [`EditInlineText`]: ./struct.EditInlineText.html
44//! [`types::Message`]: ../types/struct.Message.html
45
46#![allow(clippy::wrong_self_convention)]
47
48mod add_sticker_to_set;
49mod answer_callback_query;
50mod answer_inline_query;
51mod answer_pre_checkout_query;
52mod answer_shipping_query;
53mod create_new_sticker_set;
54mod delete_chat_photo;
55mod delete_chat_sticker_set;
56mod delete_message;
57mod delete_sticker_from_set;
58mod delete_webhook;
59mod edit_inline_caption;
60mod edit_inline_location;
61mod edit_inline_media;
62mod edit_inline_reply_markup;
63mod edit_inline_text;
64mod edit_message_caption;
65mod edit_message_location;
66mod edit_message_media;
67mod edit_message_reply_markup;
68mod edit_message_text;
69mod export_chat_invite_link;
70mod forward_message;
71mod get_chat;
72mod get_chat_administrators;
73mod get_chat_member;
74mod get_chat_members_count;
75mod get_file;
76mod get_inline_game_high_scores;
77mod get_me;
78mod get_message_game_high_scores;
79mod get_my_commands;
80mod get_sticker_set;
81mod get_updates;
82mod get_user_profile_photos;
83mod get_webhook_info;
84mod kick_chat_member;
85mod leave_chat;
86mod pin_chat_message;
87mod promote_chat_member;
88mod restrict_chat_member;
89mod send_animation;
90mod send_audio;
91mod send_chat_action;
92mod send_contact;
93mod send_dice;
94mod send_document;
95mod send_game;
96mod send_invoice;
97mod send_location;
98mod send_media_group;
99mod send_message;
100mod send_photo;
101mod send_poll;
102mod send_sticker;
103mod send_venue;
104mod send_video;
105mod send_video_note;
106mod send_voice;
107mod set_chat_administrator_custom_title;
108mod set_chat_description;
109mod set_chat_permissions;
110mod set_chat_photo;
111mod set_chat_sticker_set;
112mod set_chat_title;
113mod set_inline_game_score;
114mod set_message_game_score;
115mod set_my_commands;
116mod set_passport_data_errors;
117mod set_sticker_position_in_set;
118mod set_sticker_set_thumb;
119mod set_webhook;
120mod stop_inline_location;
121mod stop_message_location;
122mod stop_poll;
123mod unban_chat_member;
124mod unpin_chat_message;
125mod upload_sticker_file;
126
127pub use add_sticker_to_set::AddStickerToSet;
128pub use answer_callback_query::AnswerCallbackQuery;
129pub use answer_inline_query::AnswerInlineQuery;
130pub use answer_pre_checkout_query::AnswerPreCheckoutQuery;
131pub use answer_shipping_query::AnswerShippingQuery;
132pub use create_new_sticker_set::CreateNewStickerSet;
133pub use delete_chat_photo::DeleteChatPhoto;
134pub use delete_chat_sticker_set::DeleteChatStickerSet;
135pub use delete_message::DeleteMessage;
136pub use delete_sticker_from_set::DeleteStickerFromSet;
137pub use edit_inline_caption::EditInlineCaption;
138pub use edit_inline_location::EditInlineLocation;
139pub use edit_inline_media::EditInlineMedia;
140pub use edit_inline_reply_markup::EditInlineReplyMarkup;
141pub use edit_inline_text::EditInlineText;
142pub use edit_message_caption::EditMessageCaption;
143pub use edit_message_location::EditMessageLocation;
144pub use edit_message_media::EditMessageMedia;
145pub use edit_message_reply_markup::EditMessageReplyMarkup;
146pub use edit_message_text::EditMessageText;
147pub use export_chat_invite_link::ExportChatInviteLink;
148pub use forward_message::ForwardMessage;
149pub use get_chat::GetChat;
150pub use get_chat_administrators::GetChatAdministrators;
151pub use get_chat_member::GetChatMember;
152pub use get_chat_members_count::GetChatMembersCount;
153pub use get_file::GetFile;
154pub use get_inline_game_high_scores::GetInlineGameHighScores;
155pub use get_me::GetMe;
156pub use get_message_game_high_scores::GetMessageGameHighScores;
157pub use get_my_commands::GetMyCommands;
158pub use get_sticker_set::GetStickerSet;
159pub use get_user_profile_photos::GetUserProfilePhotos;
160pub use get_webhook_info::GetWebhookInfo;
161pub use kick_chat_member::KickChatMember;
162pub use leave_chat::LeaveChat;
163pub use pin_chat_message::PinChatMessage;
164pub use promote_chat_member::PromoteChatMember;
165pub use restrict_chat_member::RestrictChatMember;
166pub use send_animation::SendAnimation;
167pub use send_audio::SendAudio;
168pub use send_chat_action::SendChatAction;
169pub use send_contact::SendContact;
170pub use send_dice::SendDice;
171pub use send_document::SendDocument;
172pub use send_game::SendGame;
173pub use send_invoice::SendInvoice;
174pub use send_location::SendLocation;
175pub use send_media_group::SendMediaGroup;
176pub use send_message::SendMessage;
177pub use send_photo::SendPhoto;
178pub use send_poll::SendPoll;
179pub use send_sticker::SendSticker;
180pub use send_venue::SendVenue;
181pub use send_video::SendVideo;
182pub use send_video_note::SendVideoNote;
183pub use send_voice::SendVoice;
184pub use set_chat_administrator_custom_title::SetChatAdministratorCustomTitle;
185pub use set_chat_description::SetChatDescription;
186pub use set_chat_permissions::SetChatPermissions;
187pub use set_chat_photo::SetChatPhoto;
188pub use set_chat_sticker_set::SetChatStickerSet;
189pub use set_chat_title::SetChatTitle;
190pub use set_inline_game_score::SetInlineGameScore;
191pub use set_message_game_score::SetMessageGameScore;
192pub use set_my_commands::SetMyCommands;
193pub use set_passport_data_errors::SetPassportDataErrors;
194pub use set_sticker_position_in_set::SetStickerPositionInSet;
195pub use set_sticker_set_thumb::SetStickerSetThumb;
196pub use stop_inline_location::StopInlineLocation;
197pub use stop_message_location::StopMessageLocation;
198pub use stop_poll::StopPoll;
199pub use unban_chat_member::UnbanChatMember;
200pub use unpin_chat_message::UnpinChatMessage;
201pub use upload_sticker_file::UploadStickerFile;
202
203pub(crate) use {
204    delete_webhook::DeleteWebhook, get_updates::GetUpdates,
205    set_webhook::SetWebhook,
206};
207
208mod call_method;
209use call_method::call_method;
tbot/methods.rs

tbot/
methods.rs
