teloxide/MIGRATION_GUIDE.md

This document describes breaking changes of teloxide crate, as well as the ways to update code. Note that the list of required changes is not fully exhaustive and it may lack something in rare cases.

unreleased

teloxide

We have finally introduced three different categories for syntactic sugar:

1. A new trait RequestReplyExt that adds .reply_to(msg), equivalent to .reply_parameters(ReplyParameters::new(msg.id))

- bot.send_dice(msg.chat.id).reply_parameters(ReplyParameters::new(msg.id)).await?;
+ bot.send_dice(msg.chat.id).reply_to(msg).await?;
// or
+ bot.send_dice(msg.chat.id).reply_to(msg.id).await?;

2. A new trait RequestLinkPreviewExt that adds .disable_link_preview(true), equivalent to .link_preview_options(options)

- let options = LinkPreviewOptions {
-     is_disabled: true,
-     url: None,
-     prefer_small_media: false,
-     prefer_large_media: false,
-     show_above_text: false,
- };
- bot.send_message(msg.chat.id, "https://github.com/teloxide/teloxide").link_preview_options(options).await?;
+ bot.send_message(msg.chat.id, "https://github.com/teloxide/teloxide").disable_link_preview(true).await?;

3. A new trait BotMessagesExt that adds a shorter method for anything that requires both msg.id and msg.chat.id:

- bot.edit_message_text(msg.chat.id, msg.id, text).await?;
+ bot.edit_text(msg, text).await?;

- bot.forward_message(to_chat_id, msg.chat.id, msg.id).await?;
+ bot.forward(to_chat_id, msg).await?;

- bot.delete_message(msg.chat.id, msg.id).await?;
+ bot.delete(msg).await?;

And others like bot.edit_live_location, bot.stop_live_location, bot.set_reaction, bot.pin, bot.unpin, bot.edit_caption, bot.edit_media, bot.edit_reply_markup, bot.stop_poll_message and bot.copy methods

0.11 -> 0.12

teloxide

The rocksdb-storage feature and associated items were removed. If you need to use RocksDB, you can use the teloxide-rocksdb crate.

0.11 -> 0.11.3

teloxide

We have introduced the new trait CommandRepl that replaces the old commands_repl_(with_listener) functions:

- teloxide::commands_repl(bot, answer, Command::ty())
+ Command::repl(bot, answer)

- teloxide::commands_repl_with_listener(bot, answer, listener, Command::ty())
+ Command::repl_with_listener(bot, answer, listener)

0.10 -> 0.11

core

Requests can now be .awaited directly, without need of .send() or AutoSend. If you previously used AutoSend adaptor, you can safely remove it:

-let bot = Bot::from_env().auto_send();
+let bot = Bot::from_env();

-async fn start(bot: AutoSend<Bot>, dialogue: MyDialogue, msg: Message) -> HandlerResult {
+async fn start(bot: Bot, dialogue: MyDialogue, msg: Message) -> HandlerResult {

File's and FileMeta's fields now don't have file_ prefix. If you previously accessed the fields, you'll need to change remove the prefix:

-_ = file.file_size;
+_ = file.size;

Animation, Audio, Document, PassportFile, PhotoSize, Video, VideoNote and Voice now contain FileMeta instead of its fields. Together with rename of FileMeta's fields, you'll need to change _ to .:

-_ = animation.file_size;
+_ = animation.file.size;

Message id fields and parameters now use MessageId type, instead of i32. You may need to change code accordingly:

-let id: i32 = message.id;
+let id: MessageId = message.id;

let (cid, mid): (ChatId, i32) = get_message_to_delete_from_db();
-bot.delete_message(cid, mid).await?;
+bot.delete_message(cid, MessageId(mid)).await?;

Note that at the same time MessageId is now a tuple struct. If you've accessed its only field you'll need to change it too:

-let MessageId { message_id } = bot.copy_message(dst_chat, src_chat, mid).await?;
+let MessageId(message_id) = bot.copy_message(dst_chat, src_chat, mid).await?;
save_to_db(message_id);

Because of API updates Sticker type was refactored again. You may need to change code accordingly. See Sticker documentation for more information about the new structure.

teloxide

You can now write Ok(()) instead of respond(()) at the end of closures provided to RELPs:

teloxide::repl(bot, |bot: Bot, msg: Message| async move {
    bot.send_dice(msg.chat.id).await?;
-    respond(())
+    Ok(())
})
.await;

This is because REPLs now require the closure to return RequestError instead of a generic error type, so type inference works perfectly for a return value. If you use something other than RequestError, you can transfer your code to teloxide::dispatching, which still permits a generic error type.

"Stop tokens" were refactored, the trait is now removed and the types were renamed:

-use teloxide::dispatching::stop_token::{AsyncStopToken, AsyncStopFlag};
+use teloxide::stop::{StopToken, StopFlag, mk_stop_token};

-let (token, flag): (AsyncStopToken, AsyncStopFlag) = AsyncStopToken::new_pair();
+let (token, flag): (StopToken, StopFlag) = mk_stop_token();

macros

parse_with now accepts a Rust path to a custom parser function instead of a string:

fn custom_parser(input: String) -> Result<(u8,), ParseError> {
    todo!()
}

#[derive(BotCommands)]
enum Command {
-    #[command(parse_with = "custom_parser")]
+    #[command(parse_with = custom_parser)]
    Num(u8),
}

rename now only renames a command literally; use rename_rule to change the case of a command:

#[derive(BotCommands)]
- #[command(rename = "lowercase", description = "These commands are supported:")]
+ #[command(rename_rule = "lowercase", description = "These commands are supported:")]
enum Command {
    // ...
}

0.9 -> 0.10

core

We've added some convenience functions to InlineKeyboardButton so it's easier to construct it. Consider using them instead of variants:

-InlineKeyboardButton::new("text", InlineKeyboardButtonKind::Url(url))
+InlineKeyboardButton::url("text", url)

file_size fields are now u32, you may need to update your code accordingly:

-let file_size: u64 = audio.file_size?;
+let file_size: u32 = audio.file_size;

Some places now use FileMeta instead of File, you may need to change types.

Sticker and StickerSet now has a kind field instead of is_animated and is_video:

+use teloxide::types::StickerKind::*;
-match () {
+match sticker.kind {
-    _ if sticker.is_animated => /* handle animated */,
+    Animated => /* handle animated */,
-    _ if sticker.is_video => /* handle video */,
+    Video => /* handle video */,
-    _ => /* handle normal */,
+    Webp => /* handle normal */,
}

teloxide

Teloxide itself doesn't have any major API changes. Note however that some function were deprecated:

• Instead of dispatching::update_listeners::polling use polling_builder
• Instead of Dispatcher::setup_ctrlc_handler use DispatcherBuilder::enable_ctrlc_handler

0.7 -> 0.8

core

user.id now uses UserId type, ChatId now represents only chat id, not channel username, all chat_id function parameters now accept Recipient (if they allow for channel usernames).

If you used to work with chat/user ids (for example saving them to a database), you may need to change your code to account for new types. Some examples how that may look like:

-let user_id: i64 = user.id;
+let UserId(user_id) = user.id;
db.save(user_id, ...);

-let chat_id: i64 = db.get();
+let chat_id = ChatId(db.get());
bot.send_message(chat_id, "Hi!").await?;

RequestError::RetryAfter now has a field of type Duration, instead of i32.

teloxide

The old dispatching system was removed. If you still hasn't moved to the new one, read the 0.5 -> 0.6 migration guide for more information on this topic. Note that since the old dispatching was removed, the new dispatching system now lives in the dispatching module, not dispatching2 module.

If you implement UpdateListener yourself, note that StopToken is now required to be Send.

BotCommand trait was renamed to BotCommands. BotCommands::descriptions not returns CommandDescriptions instead of String. To get string, you can call .to_string().

#[derive(DialogueState)] is deprecated in favour of teloxide::handler!, a more flexible API for dealing with dialogues. examples/dialogue.rs shows how to use it.

0.6 -> 0.7

teloxide

In order to make Dispatcher implement Send, DispatcherBuilder::{default_handler, error_handler} now accept handlers that implements Send + Sync. If you used !Send or !Sync handlers here, you may need to change that.

0.5 -> 0.6

core

• InputFile now can't be created like InputFile::Url(url) or matched on, use constructors like InputFile::url, InputFile::file, etc.
• RequestError and DownloadError error variants were slightly renamed
• ChatPermissions is now bitflags.

teloxide

v0.6 of teloxide introduces a new dispatching model based on the chain of responsibility pattern. To use it, you need to replace prelude with prelude2 and dispatching with dispatching2. Instead of using old REPLs, you should now use teloxide::repls2.

The whole design is different from the previous one based on Tokio streams. In this section, we are only to address the most common usage scenarios.

First of all, now there are no streams. Instead of using streams, you use dptree, which is a more suitable alternative for our purposes. Thus, if you previously used Dispatcher::messages_handler, now you should use Update::filter_message(), and so on.

Secondly, Dispatcher has been split into two separate abstractions: DispatcherBuilder and Dispatcher. The calling sequence is simple: you call Dispatcher::builder(bot, handler), set up your stuff, and then call .build() to obtain Dispatcher. Later, you can .setup_ctrlc_handler() on it and finally .dispatch() (or .dispatch_with_listener()).

Lastly, the dialogue management system has been greatly simplified. Just compare the new examples/dialogue.rs with the old one to see the difference. Now you don't need TransitionIn, TransitionOut, #[teloxide(subtransition)], etc. All you need is to derive DialogueState for your FSM enumeration, call .enter_dialogue() and write handlers for each of a dialogue's states. Instead of supplying dependencies in the aux parameter of Transition::react, you can just call .dependencies() while setting up the dispatcher and all the dependencies will be passed to your handler functions as parameters.

For more information, please look at the appropriate documentation pages and the updated examples. Note that, in one of the upcoming releases, the old dispatching model will be removed, so we highly encourage you to migrate your bots to the new one.

Thanks for using teloxide!

0.4 -> 0.5

core

Field type changes

Types of some fields were changed to be more accurate. If you used them, you may need to change types in your code too.

Example:

let ps: PhotoSize = /* ... */;
-let w: i32 = ps.width;
+let w: u32 = ps.width;

List of changed types:

• PhotoSoze::width: i32 -> u32
• PhotoSoze::height: i32 -> u32
• Restricted::until_date: i32 -> DateTime<Utc>
• Kicked::until_date (Banned::until_date): i32 -> DateTime<Utc>
• PublicChatSupergroup::slow_mode_delay: Option<i32> -> Option<u32>
• User::id: i32 -> i64 (note: all methods which are accepting user_id were changed too)

Method output types

In teloxide v0.4 (core v0.2) some API methods had wrong return types. This made them practically unusable as they've always returned parsing error. On the off-chance you were using the methods, you may need to adjust types in your code.

List of changed return types:

• get_chat_administrators: ChatMember -> Vec<ChatMember>
• send_chat_action: Message -> True
• leave_chat: String -> True
• pin_chat_message: String -> True
• set_chat_description: String -> True
• set_chat_photo: String -> True
• set_chat_title: String -> True
• unpin_all_chat_messages: String -> True
• unpin_chat_message: String -> True

Method parameter types

Some API methods accept different types now. If you've used changed parameters, you need to adjust code for new types.

Examples:

let bot = Bot::new("TOKEN").auto_send();

-bot.set_webhook("url").await?;
+bot.set_webhook(Url::parse("url").unwrap()).await?;

let link = bot
    .create_chat_invite_link(chat_id)
-    .expire_date(timestamp)
# Note: this is not the only way to create `DateTime`. Refer to `chrono` docs for more.
+    .expire_date(DateTime::<Utc>::from_utc(
+        NaiveDateTime::from_timestamp(timestamp, 0), Utc)
+    )
    .await?;

See also: teloxide examples fixes.

List of changed required params:

• SetWebhook::url: String -> Url

List of changed optional params:

• AnswerCallbackQuery::url: String -> Url
• SendInvoice::photo_url: String -> Url
• CreateChatInviteLink::expire_date: i64 -> DateTime<Utc>
• EditChatInviteLink::expire_date: i64 -> DateTime<Utc>
• KickChatMember::until_date: u64 -> DateTime<Utc>
• RestrictChatMember::until_date: u64 -> DateTime<Utc>
• SendPoll::close_date: u64 -> DateTime<Utc>

Renamed items

Some items (fields, variants, types, methods) were renamed. If you used them, you should start using new names.

Example:

-bot.send_chat_action(chat, ChatAction::RecordAudio).await?;
+bot.send_chat_action(chat, ChatAction::RecordVoice).await?;

-if chat_member.is_kicked() {
+if chat_member.is_banned() {
    /* ... */
}

List of renamed items:

• ChatAction::RecordAudio -> RecordVoice
• ChatAction::UploadAudio -> UploadVoice
• ChatMemberKind::Creator -> Owner
• ChatMemberKind::Kicked -> Banned
• Creator -> Owner
• Kicked -> Banned
• ChatMemberKind::is_Creator -> is_owner *
• ChatMemberKind::is_kicked -> is_banned *
• ChatMemberStatus::Creator -> Owner
• ChatMemberStatus::Kicked -> Banned
• kick_chat_member -> ban_chat_member *
• get_chat_members_count -> get_chat_member_count *

* Old methods are still accessible, but deprecated

Added impl Clone for {CacheMe, DefaultParseMode, Throttle}

Previously said bot adaptors were lacking Clone implementation. To work around this issue it was proposed to wrap bot in Arc. Now it's not required, so you can remove the Arc:

let bot = Bot::new(token).parse_mode(ParseMode::MarkdownV2);
-let bot = Arc::new(bot);

teloxide

Mutable reference for dispatching

Dispatcher::dispatch and Dispatcher::dispatch_with_listener now require mutable (unique) reference to self. If you've used variable to store Dispatcher, you need to make it mutable:

-let dp = Dispatcher::new();
+let mut dp = Dispatcher::new();
/* ... */
dp.dispatch();

Listener refactor

UpdateListener trait was refactored. If you've used polling/polling_default provided by teloxide, no changes are required. If, however, you've used or implemented UpdateListener directly or used a Stream as a listener, then you need to refactor your code too.

See also: teloxide examples fixes.

polling_default

polling_default is now async, but removes webhook.

Example fix:

-let listener = polling_default(bot);
+let listener = polling_default(bot).await;