OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2025-01-03 17:52:12 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #755 from teloxide/migration_guide_fixes

Browse source 
migration guide fixes
This commit is contained in:
Waffle Maybe 2022-10-31 14:00:52 +04:00 committed by GitHub
commit c9278e2c10
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
MIGRATION_GUIDE.md
View file

@ -7,12 +7,12 @@ Note that the list of required changes is not fully exhaustive and it may lack s
We have introduced the new trait `CommandRepl` that replaces the old `commands_repl_(with_listener)` functions: We have introduced the new trait `CommandRepl` that replaces the old `commands_repl_(with_listener)` functions:
```diff,rust ```diff
- teloxide::commands_repl(bot, answer, Command::ty()) - teloxide::commands_repl(bot, answer, Command::ty())
+ Command::repl(bot, answer) + Command::repl(bot, answer)
``` ```
```diff,rust ```diff
- teloxide::commands_repl_with_listener(bot, answer, listener, Command::ty()) - teloxide::commands_repl_with_listener(bot, answer, listener, Command::ty())
+ Command::repl_with_listener(bot, answer, listener) + Command::repl_with_listener(bot, answer, listener)
``` ```
@ -24,12 +24,12 @@ We have introduced the new trait `CommandRepl` that replaces the old `commands_r
Requests can now be `.await`ed directly, without need of `.send()` or `AutoSend`. Requests can now be `.await`ed directly, without need of `.send()` or `AutoSend`.
If you previously used `AutoSend` adaptor, you can safely remove it: If you previously used `AutoSend` adaptor, you can safely remove it:
```diff,rust ```diff
-let bot = Bot::from_env().auto_send(); -let bot = Bot::from_env().auto_send();
+let bot = Bot::from_env(); +let bot = Bot::from_env();
``` ```
```diff,rust ```diff
-async fn start(bot: AutoSend<Bot>, dialogue: MyDialogue, msg: Message) -> HandlerResult { -async fn start(bot: AutoSend<Bot>, dialogue: MyDialogue, msg: Message) -> HandlerResult {
+async fn start(bot: Bot, dialogue: MyDialogue, msg: Message) -> HandlerResult { +async fn start(bot: Bot, dialogue: MyDialogue, msg: Message) -> HandlerResult {
``` ```
@ -57,7 +57,7 @@ You may need to change code accordingly:
-let id: i32 = message.id; -let id: i32 = message.id;
+let id: MessageId = message.id; +let id: MessageId = message.id;
``` ```
```diff,rust ```diff
let (cid, mid): (ChatId, i32) = get_message_to_delete_from_db(); let (cid, mid): (ChatId, i32) = get_message_to_delete_from_db();
-bot.delete_message(cid, mid).await?; -bot.delete_message(cid, mid).await?;
+bot.delete_message(cid, MessageId(mid)).await?; +bot.delete_message(cid, MessageId(mid)).await?;
@ -66,7 +66,7 @@ let (cid, mid): (ChatId, i32) = get_message_to_delete_from_db();
Note that at the same time `MessageId` is now a tuple struct. 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: If you've accessed its only field you'll need to change it too:
```diff,rust ```diff
-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?;
+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); save_to_db(message_id);
@ -80,7 +80,7 @@ See `Sticker` documentation for more information about the new structure.
You can now write `Ok(())` instead of `respond(())` at the end of closures provided to RELPs: You can now write `Ok(())` instead of `respond(())` at the end of closures provided to RELPs:
```diff,rust ```diff
teloxide::repl(bot, |bot: Bot, msg: Message| async move { teloxide::repl(bot, |bot: Bot, msg: Message| async move {
bot.send_dice(msg.chat.id).await?; bot.send_dice(msg.chat.id).await?;
- respond(()) - respond(())
@ -91,11 +91,21 @@ teloxide::repl(bot, |bot: Bot, msg: Message| async move {
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. 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:
```diff
-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 ### macros
`parse_with` now accepts a Rust _path_ to a custom parser function instead of a string: `parse_with` now accepts a Rust _path_ to a custom parser function instead of a string:
```diff,rust ```diff
fn custom_parser(input: String) -> Result<(u8,), ParseError> { fn custom_parser(input: String) -> Result<(u8,), ParseError> {
todo!() todo!()
} }
@ -110,7 +120,7 @@ enum Command {
`rename` now only renames a command literally; use `rename_rule` to change the case of a command: `rename` now only renames a command literally; use `rename_rule` to change the case of a command:
```diff,rust ```diff
#[derive(BotCommands)] #[derive(BotCommands)]
- #[command(rename = "lowercase", description = "These commands are supported:")] - #[command(rename = "lowercase", description = "These commands are supported:")]
+ #[command(rename_rule = "lowercase", description = "These commands are supported:")] + #[command(rename_rule = "lowercase", description = "These commands are supported:")]