teloxide

A full-featured framework that empowers you to easily build [Telegram bots](https://telegram.org/blog/bot-revolution) using the [`async`/`.await`](https://rust-lang.github.io/async-book/01_getting_started/01_chapter.html) syntax in [Rust](https://www.rust-lang.org/). It handles all the difficult stuff so you can focus only on your business logic.
## Highlights - **Declarative design.** teloxide is based upon [`dptree`], a functional-style [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style. [`dptree`]: https://github.com/p0lunin/dptree [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern - **Dialogues management subsystem.** Our dialogues management subsystem is simple and easy-to-use, and, furthermore, is agnostic of how/where dialogues are stored. For example, you can just replace a one line to achieve [persistence]. Out-of-the-box storages include [Redis] and [Sqlite]. [persistence]: https://en.wikipedia.org/wiki/Persistence_(computer_science) [Redis]: https://redis.io/ [Sqlite]: https://www.sqlite.org - **Strongly typed commands.** You can describe bot commands as enumerations, and then they'll be automatically constructed from strings — just like JSON structures in [`serde-json`] and command-line arguments in [`structopt`]. [`structopt`]: https://github.com/TeXitoi/structopt [`serde-json`]: https://github.com/serde-rs/json ## Setting up your environment 1. [Download Rust](http://rustup.rs/). 2. Create a new bot using [@Botfather](https://t.me/botfather) to get a token in the format `123456789:blablabla`. 3. Initialise the `TELOXIDE_TOKEN` environmental variable to your token: ```bash # Unix-like $ export TELOXIDE_TOKEN= # Windows command line $ set TELOXIDE_TOKEN= # Windows PowerShell $ $env:TELOXIDE_TOKEN= ``` 4. Make sure that your Rust compiler is up to date: ```bash # If you're using stable $ rustup update stable $ rustup override set stable # If you're using nightly $ rustup update nightly $ rustup override set nightly ``` 5. Run `cargo new my_bot`, enter the directory and put these lines into your `Cargo.toml`: ```toml [dependencies] teloxide = { version = "0.5", features = ["macros", "auto-send"] } log = "0.4" pretty_env_logger = "0.4.0" tokio = { version = "1.8", features = ["rt-multi-thread", "macros"] } ``` ## API overview ### The dices bot This bot replies with a dice throw to each received message: ([Full](./examples/dices.rs)) ```rust,no_run use teloxide::prelude2::*; #[tokio::main] async fn main() { teloxide::enable_logging!(); log::info!("Starting dices_bot..."); let bot = Bot::from_env().auto_send(); teloxide::repls2::repl(bot, |message: Message, bot: AutoSend| async move { bot.send_dice(message.chat.id).await?; respond(()) }) .await; } ```
### Commands Commands are strongly typed and defined declaratively, similar to how we define CLI using [structopt] and JSON structures in [serde-json]. The following bot accepts these commands: - `/username ` - `/usernameandage ` - `/help` [structopt]: https://docs.rs/structopt/0.3.9/structopt/ [serde-json]: https://github.com/serde-rs/json ([Full](./examples/simple_commands.rs)) ```rust,no_run use teloxide::{prelude2::*, utils::command::BotCommand}; use std::error::Error; #[derive(BotCommand, Clone)] #[command(rename = "lowercase", description = "These commands are supported:")] enum Command { #[command(description = "display this text.")] Help, #[command(description = "handle a username.")] Username(String), #[command(description = "handle a username and an age.", parse_with = "split")] UsernameAndAge { username: String, age: u8 }, } async fn answer( bot: AutoSend, message: Message, command: Command, ) -> Result<(), Box> { match command { Command::Help => bot.send_message(message.chat.id, Command::descriptions()).await?, Command::Username(username) => { bot.send_message(message.chat.id, format!("Your username is @{}.", username)).await? } Command::UsernameAndAge { username, age } => { bot.send_message( message.chat.id, format!("Your username is @{} and age is {}.", username, age), ) .await? } }; Ok(()) } #[tokio::main] async fn main() { teloxide::enable_logging!(); log::info!("Starting simple_commands_bot..."); let bot = Bot::from_env().auto_send(); teloxide::repls2::commands_repl(bot, answer, Command::ty()).await; } ```
### Dialogues management A dialogue is typically described by an enumeration where each variant is one of possible dialogue's states. There are also _state handler functions_, which may turn a dialogue from one state to another, thereby forming an [FSM]. [FSM]: https://en.wikipedia.org/wiki/Finite-state_machine Below is a bot that asks you three questions and then sends the answers back to you: ([Full](examples/dialogue.rs)) ```rust,ignore use teloxide::{dispatching2::dialogue::InMemStorage, macros::DialogueState, prelude2::*}; type MyDialogue = Dialogue>; #[derive(DialogueState, Clone)] #[handler_out(anyhow::Result<()>)] pub enum State { #[handler(handle_start)] Start, #[handler(handle_receive_full_name)] ReceiveFullName, #[handler(handle_receive_age)] ReceiveAge { full_name: String }, #[handler(handle_receive_location)] ReceiveLocation { full_name: String, age: u8 }, } impl Default for State { fn default() -> Self { Self::Start } } #[tokio::main] async fn main() { teloxide::enable_logging!(); log::info!("Starting dialogue_bot..."); let bot = Bot::from_env().auto_send(); DispatcherBuilder::new( bot, Update::filter_message() .add_dialogue::, State>() .dispatch_by::(), ) .dependencies(dptree::deps![InMemStorage::::new()]) .build() .setup_ctrlc_handler() .dispatch() .await; } async fn handle_start( bot: AutoSend, msg: Message, dialogue: MyDialogue, ) -> anyhow::Result<()> { bot.send_message(msg.chat_id(), "Let's start! What's your full name?").await?; dialogue.update(State::ReceiveFullName).await?; Ok(()) } async fn handle_receive_full_name( bot: AutoSend, msg: Message, dialogue: MyDialogue, ) -> anyhow::Result<()> { match msg.text() { Some(text) => { bot.send_message(msg.chat_id(), "How old are you?").await?; dialogue.update(State::ReceiveAge { full_name: text.into() }).await?; } None => { bot.send_message(msg.chat_id(), "Send me plain text.").await?; } } Ok(()) } async fn handle_receive_age( bot: AutoSend, msg: Message, dialogue: MyDialogue, (full_name,): (String,), ) -> anyhow::Result<()> { match msg.text().map(|text| text.parse::()) { Some(Ok(age)) => { bot.send_message(msg.chat_id(), "What's your location?").await?; dialogue.update(State::ReceiveLocation { full_name, age }).await?; } _ => { bot.send_message(msg.chat_id(), "Send me a number.").await?; } } Ok(()) } async fn handle_receive_location( bot: AutoSend, msg: Message, dialogue: MyDialogue, (full_name, age): (String, u8), ) -> anyhow::Result<()> { match msg.text() { Some(location) => { let message = format!("Full name: {}\nAge: {}\nLocation: {}", full_name, age, location); bot.send_message(msg.chat_id(), message).await?; dialogue.exit().await?; } None => { bot.send_message(msg.chat_id(), "Send me plain text.").await?; } } Ok(()) } ```
[More examples >>](./examples) ## FAQ **Q: Where I can ask questions?** A: [Issues](https://github.com/teloxide/teloxide/issues) is a good place for well-formed questions about the library design, enhancements, and bug reports. If you can't compile your bot due to compilation errors and need quick help, feel free to ask in [our official Telegram group](https://t.me/teloxide). **Q: Do you support the Telegram API for clients?** A: No, only the bots API. **Q: Can I use webhooks?** A: teloxide doesn't provide special API for working with webhooks due to their nature with lots of subtle settings. Instead, you should setup your webhook by yourself, as shown in [`examples/ngrok_ping_pong_bot`](./examples/ngrok_ping_pong_bot/src/main.rs) and [`examples/heroku_ping_pong_bot`](./examples/heroku_ping_pong_bot/src/main.rs). Associated links: - [Marvin's Marvellous Guide to All Things Webhook](https://core.telegram.org/bots/webhooks) - [Using self-signed certificates](https://core.telegram.org/bots/self-signed) **Q: Can I use different loggers?** A: Yes. You can setup any logger, for example, [fern], e.g. teloxide has no specific requirements as it depends only on [log]. Remember that [`enable_logging!`] and [`enable_logging_with_filter!`] are just **optional** utilities. [fern]: https://crates.io/crates/fern [log]: https://crates.io/crates/log [`enable_logging!`]: https://docs.rs/teloxide/latest/teloxide/macro.enable_logging.html [`enable_logging_with_filter!`]: https://docs.rs/teloxide/latest/teloxide/macro.enable_logging_with_filter.html ## Community bots Feel free to propose your own bot to our collection! - [WaffleLapkin/crate_upd_bot](https://github.com/WaffleLapkin/crate_upd_bot) -- A bot that notifies about crate updates. - [mxseev/logram](https://github.com/mxseev/logram) -- Utility that takes logs from anywhere and sends them to Telegram. - [alexkonovalov/PedigreeBot](https://github.com/alexkonovalov/PedigreeBot) -- A Telegram bot for building family trees. - [Hermitter/tepe](https://github.com/Hermitter/tepe) -- A CLI to command a bot to send messages and files over Telegram. - [dracarys18/grpmr-rs](https://github.com/dracarys18/grpmr-rs) -- A Telegram group manager bot with variety of extra features. - [steadylearner/subreddit_reader](https://github.com/steadylearner/Rust-Full-Stack/tree/master/commits/teloxide/subreddit_reader) -- A bot that shows the latest posts at Rust subreddit. - [myblackbeard/basketball-betting-bot](https://github.com/myblackbeard/basketball-betting-bot) -- The bot lets you bet on NBA games against your buddies. - [ArtHome12/vzmuinebot](https://github.com/ArtHome12/vzmuinebot) -- Telegram bot for food menu navigate. - [ArtHome12/cognito_bot](https://github.com/ArtHome12/cognito_bot) -- The bot is designed to anonymize messages to a group. - [pro-vim/tg-vimhelpbot](https://github.com/pro-vim/tg-vimhelpbot) -- Link `:help` for Vim in Telegram. - [sschiz/janitor-bot](https://github.com/sschiz/janitor-bot) -- A bot that removes users trying to join to a chat that is designed for comments. - [slondr/BeerHolderBot](https://gitlab.com/slondr/BeerHolderBot) -- A bot that holds your beer. - [MustafaSalih1993/Miss-Vodka-Telegram-Bot](https://github.com/MustafaSalih1993/Miss-Vodka-Telegram-Bot) -- A Telegram bot written in rust using "Teloxide" library. - [x13a/tg-prompt](https://github.com/x13a/tg-prompt) -- Telegram prompt. - [magnickolas/remindee-bot](https://github.com/magnickolas/remindee-bot) -- Telegram bot for managing reminders. - [cyberknight777/knight-bot](https://gitlab.com/cyberknight777/knight-bot) -- A Telegram bot with variety of fun features. - [wa7sa34cx/the-black-box-bot](https://github.com/wa7sa34cx/the-black-box-bot) -- This is the Black Box Telegram bot. You can hold any items in it. - [crapstone/hsctt](https://codeberg.org/crapstones-bots/hsctt) -- A Telegram bot that searches for HTTP status codes in all messages and replies with the text form. - [alenpaul2001/AurSearchBot](https://gitlab.com/alenpaul2001/aursearchbot) -- Telegram bot for searching AUR in inline mode. ## Contributing See [`CONRIBUTING.md`](CONTRIBUTING.md).