Struct tbot::event_loop::EventLoop

pub struct EventLoop { /* private fields */ }

Provides an event loop for handling Telegram updates.

With EventLoop, you can configure handlers and start listening to updates via either polling or webhook.

let mut bot = tbot::from_env!("BOT_TOKEN").event_loop();

bot.text(|_| async { println!("Got a text message") });

bot.polling().start();

tbot has many update handlers, such as text you have seen in the example. You can find all of them below on this page.

Implementations

impl EventLoop

pub fn into_stateful<S>(self, state: S) -> StatefulEventLoop<S>where
    S: Send + Sync + 'static,

Turns this event loop into a stateful one. Handlers added on this event loop are kept.

pub fn username(&mut self, username: String)

Sets the bot’s username.

The username is used when checking if a command such as /command@username was directed to the bot.

pub async fn fetch_username(&mut self) -> Result<(), MethodCall>

Fetches the bot’s username.

The username is used when checking if a command such as /command@username was directed to the bot.

pub fn polling(self) -> Polling

Starts polling configuration.

pub fn webhook(self, url: &str, port: u16) -> Webhook<'_>

Starts webhook configuration.

See our wiki to learn how to use webhook with tbot.

pub fn command<H, F>(&mut self, command: &'static str, handler: H)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for a command.

Note that commands such as /command@username will be completely ignored unless you configure the event loop with your bot’s username with either username or fetch_username.

It is idiomatic to omit the leading / in the command. Even though keeping it will work as expected, tbot will emit a warning in this case.

pub fn command_with_description<H, F>(
    &mut self,
    command: &'static str,
    description: &'static str,
    handler: H
)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for a command and sets its description.

Note that commands such as /command@username will be completely ignored unless you configure the event loop with your bot’s username with either username or fetch_username.

It is idiomatic to omit the leading / in the command. Even though keeping it will work as expected, tbot will emit a warning in this case.

pub fn commands<Cm, H, F>(&mut self, commands: Cm, handler: H)where
    Cm: IntoIterator<Item = &'static str>,
    F: Future<Output = ()> + Send + 'static,
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,

Registers a new handler for a sequence of commands.

Note that commands such as /command@username will be completely ignored unless you configure the event loop with your bot’s username with either username or fetch_username.

It is idiomatic to omit the leading / in the commands. Even though keeping it will work as expected, tbot will emit a warning in this case.

pub fn start<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /start command.

pub fn start_with_description<H, F>(
    &mut self,
    description: &'static str,
    handler: H
)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /start command and sets its description.

pub fn settings<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /settings command.

pub fn settings_with_description<H, F>(
    &mut self,
    description: &'static str,
    handler: H
)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /settings command and sets its description.

pub fn help<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /help command.

pub fn help_with_description<H, F>(
    &mut self,
    description: &'static str,
    handler: H
)where
    H: Fn(Arc<Command>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the /help command and sets its description.

pub fn edited_command<H, F>(&mut self, command: &'static str, handler: H)where
    H: Fn(Arc<EditedCommand>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for an edited command.

It is idiomatic to omit the leading / in the commands. Even though keeping it will work as expected, tbot will emit a warning in this case.

pub fn edited_commands<Cm, H, F>(&mut self, commands: Cm, handler: H)where
    Cm: IntoIterator<Item = &'static str>,
    F: Future<Output = ()> + Send + 'static,
    H: Fn(Arc<EditedCommand>) -> F + Send + Sync + 'static,

Registers a new handler for an edited command from sequence of commands.

It is idiomatic to omit the leading / in the commands. Even though keeping it will work as expected, tbot will emit a warning in this case.

pub fn any_update<H, F>(&mut self, handler: H)where
    H: Fn(Arc<AnyUpdate>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for all incoming updates.

any_update handlers are spawned before specialized handlers, for every update that could be deserialized (this means that processing new updates on old versions of tbot is not possible even via any_update).

Note “spawned”: every handler is executed using [tokio::spawn], and tbot won’t wait for them to finish. As such, any_update is not suitable for running some code before every specialized handler.

Also, any_update does not affect unhandled in any way. It’s executed if a specialized handler corresponding to the incoming update wasn’t registered.

Registering specialized handler is still preferred. if at least one any_update handler is registered, tbot will have to clone every update in order to execute these and specialized handlers.

pub fn animation<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Animation>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for animations.

pub fn audio<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Audio>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for audio.

pub fn changed_auto_delete_timer<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ChangedAutoDeleteTimer>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for changed auto-delete timers.

pub fn chat_member<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ChatMember>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for chat members’ updated information.

pub fn chosen_inline<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ChosenInline>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for chosen inline results.

pub fn contact<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Contact>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for contacts.

pub fn connected_website<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ConnectedWebsite>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for connected websites.

pub fn created_group<H, F>(&mut self, handler: H)where
    H: Fn(Arc<CreatedGroup>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for created groups.

pub fn message_data_callback<H, F>(&mut self, handler: H)where
    H: Fn(Arc<MessageDataCallback>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for data callbacks from chat messages.

pub fn inline_data_callback<H, F>(&mut self, handler: H)where
    H: Fn(Arc<InlineDataCallback>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for data callbacks from inline messages.

pub fn deleted_chat_photo<H, F>(&mut self, handler: H)where
    H: Fn(Arc<DeletedChatPhoto>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for deleted chat photos.

pub fn dice<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Dice>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for dice.

pub fn document<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Document>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for documents.

pub fn edited_animation<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedAnimation>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited animations.

pub fn edited_audio<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedAudio>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited audio.

pub fn edited_document<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedDocument>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited documents.

pub fn edited_location<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedLocation>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited locations.

pub fn edited_photo<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedPhoto>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited photos.

pub fn edited_text<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedText>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited text messages.

pub fn edited_video<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EditedVideo>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for edited videos.

pub fn ended_voice_chat<H, F>(&mut self, handler: H)where
    H: Fn(Arc<EndedVoiceChat>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for when a voice chat is ended.

pub fn message_game_callback<H, F>(&mut self, handler: H)where
    H: Fn(Arc<MessageGameCallback>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for game callbacks from chat messages.

pub fn inline_game_callback<H, F>(&mut self, handler: H)where
    H: Fn(Arc<InlineGameCallback>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for game callbacks from inline messages.

pub fn game<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Game>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for game messages.

pub fn inline<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Inline>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for inline queries.

pub fn invited_voice_chat_participants<H, F>(&mut self, handler: H)where
    H: Fn(Arc<InvitedVoiceChatParticipants>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for when users are invited to a voice chat.

pub fn invoice<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Invoice>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for invoices.

pub fn left_member<H, F>(&mut self, handler: H)where
    H: Fn(Arc<LeftMember>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for left members.

pub fn location<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Location>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for locations.

pub fn migration<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Migration>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for migrations.

pub fn my_chat_member<H, F>(&mut self, handler: H)where
    H: Fn(Arc<MyChatMember>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for the bot’s update chat member status.

pub fn new_chat_photo<H, F>(&mut self, handler: H)where
    H: Fn(Arc<NewChatPhoto>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for new chat photos.

pub fn new_chat_title<H, F>(&mut self, handler: H)where
    H: Fn(Arc<NewChatTitle>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for new chat titles.

pub fn new_members<H, F>(&mut self, handler: H)where
    H: Fn(Arc<NewMembers>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for new members.

pub fn passport<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Passport>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for passport data.

pub fn payment<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Payment>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for successful payments.

pub fn photo<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Photo>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for photos.

pub fn pinned_message<H, F>(&mut self, handler: H)where
    H: Fn(Arc<PinnedMessage>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for pinned messages.

pub fn poll<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Poll>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for poll messages.

pub fn pre_checkout<H, F>(&mut self, handler: H)where
    H: Fn(Arc<PreCheckout>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for pre-checkout queries.

pub fn proximity_alert<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ProximityAlert>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for proximity alerts.

pub fn scheduled_voice_chat<H, F>(&mut self, handler: H)where
    H: Fn(Arc<ScheduledVoiceChat>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for when a voice chat is scheduled.

pub fn shipping<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Shipping>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for shipping queries.

pub fn started_voice_chat<H, F>(&mut self, handler: H)where
    H: Fn(Arc<StartedVoiceChat>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for when a voice chat is started.

pub fn sticker<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Sticker>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for stickers.

pub fn text<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Text>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for text messages.

pub fn unhandled<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Unhandled>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for unhandled updates.

Note that regisering any_update handlers does not affect unhandled handlers in any way. An unhandled handler is spawned if a specialized handler corresponding to the incoming update was not registered.

pub fn updated_poll<H, F>(&mut self, handler: H)where
    H: Fn(Arc<UpdatedPoll>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for new states of polls.

pub fn poll_answer<H, F>(&mut self, handler: H)where
    H: Fn(Arc<PollAnswer>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for new answers in the poll.

pub fn venue<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Venue>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for venues.

pub fn video<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Video>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for videos.

pub fn video_note<H, F>(&mut self, handler: H)where
    H: Fn(Arc<VideoNote>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for video notes.

pub fn voice<H, F>(&mut self, handler: H)where
    H: Fn(Arc<Voice>) -> F + Send + Sync + 'static,
    F: Future<Output = ()> + Send + 'static,

Registers a new handler for voice messages.