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

Merge pull request #1022 from teloxide/improve-terminatedbyothergetupdates-docs

Browse source 
improve `ApiError::TerminatedByOtherGetUpdates` docs
This commit is contained in:
Tima Kinsart 2024-03-25 12:40:38 +00:00 • committed by GitHub
commit bc0a21d212
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
crates/teloxide-core/src/errors.rs
View file

@ -677,8 +677,12 @@ impl_api_error! {
/// [`SendMessage`]: crate::payloads::SendMessage /// [`SendMessage`]: crate::payloads::SendMessage
WrongHttpUrl = "Bad Request: wrong HTTP URL", WrongHttpUrl = "Bad Request: wrong HTTP URL",
/// Occurs when bot tries GetUpdate before the timeout. Make sure that only /// Occurs when multiple [`GetUpdates`] calls happen at the same time.
/// one Updater is running. ///
/// This can happen if
/// 1. You are running multiple bot instances
/// 2. You are running multiple update consumers (like `Dispatcher` or `repl`)
/// 3. You are calling [`GetUpdates`] yourself and the second call is done before the first one finishes
/// ///
/// May happen in methods: /// May happen in methods:
/// 1. [`GetUpdates`] /// 1. [`GetUpdates`]

2
crates/teloxide/src/update_listeners.rs
View file

@ -63,7 +63,7 @@ pub trait UpdateListener:
type Err; type Err;
/// Returns a token which stops this listener. /// Returns a token which stops this listener.
/// ///
/// The [`stop`] function of the token is not guaranteed to have an /// The [`stop`] function of the token is not guaranteed to have an
/// immediate effect. That is, some listeners can return updates even /// immediate effect. That is, some listeners can return updates even
/// after [`stop`] is called (e.g.: because of buffering). /// after [`stop`] is called (e.g.: because of buffering).

10
crates/teloxide/src/update_listeners/polling.rs
View file

@ -195,20 +195,20 @@ where
/// telegram. /// telegram.
/// ///
/// ```mermaid /// ```mermaid
/// sequenceDiagram /// sequenceDiagram
/// participant C as Consumer /// participant C as Consumer
/// participant P as Polling /// participant P as Polling
/// participant T as Telegram /// participant T as Telegram
/// ///
/// link C: Dispatcher @ ../struct.Dispatcher.html /// link C: Dispatcher @ ../struct.Dispatcher.html
/// link C: repl @ ../../fn.repl.html /// link C: repl @ ../../fn.repl.html
/// ///
/// C->>P: next /// C->>P: next
/// ///
/// P->>+T: Updates? (offset = 0) /// P->>+T: Updates? (offset = 0)
/// Note right of T: timeout /// Note right of T: timeout
/// T->>-P: None /// T->>-P: None
/// ///
/// P->>+T: Updates? (offset = 0) /// P->>+T: Updates? (offset = 0)
/// Note right of T: <= timeout /// Note right of T: <= timeout
/// T->>-P: updates with ids [3, 4] /// T->>-P: updates with ids [3, 4]
@ -217,10 +217,10 @@ where
/// ///
/// C->>P: next /// C->>P: next
/// P->>C: update(4) /// P->>C: update(4)
/// ///
/// C->>P: next /// C->>P: next
/// ///
/// P->>+T: Updates? (offset = 5) /// P->>+T: Updates? (offset = 5)
/// Note right of T: <= timeout /// Note right of T: <= timeout
/// T->>-P: updates with ids [5] /// T->>-P: updates with ids [5]
/// ///