mirror of
https://github.com/teloxide/teloxide.git
synced 2025-01-18 15:20:15 +01:00
Lay out the difference between REPLs and dispatching
This commit is contained in:
parent
431cdd1abb
commit
3bdd6bdcb7
4 changed files with 42 additions and 0 deletions
|
@ -187,12 +187,36 @@
|
||||||
//! useful features. See [`examples/dispatching_features.rs`] as a more involved
|
//! useful features. See [`examples/dispatching_features.rs`] as a more involved
|
||||||
//! example.
|
//! example.
|
||||||
//!
|
//!
|
||||||
|
//! ## Dispatching or REPLs?
|
||||||
|
//!
|
||||||
|
//! The difference between dispatching and the REPLs ([`crate::repl`] & co) is
|
||||||
|
//! that dispatching allows you a greater degree of flexibility at the cost of a
|
||||||
|
//! bit more complicated setup.
|
||||||
|
//!
|
||||||
|
//! Here are things that dispatching can do, but REPLs can't:
|
||||||
|
//! - Handle different kinds of [`Update`];
|
||||||
|
//! - [Pass dependencies](struct.DispatcherBuilder.html#method.dependencies) to
|
||||||
|
//! handlers;
|
||||||
|
//! - Disable a [default Ctrl-C
|
||||||
|
//! handling](struct.DispatcherBuilder.html#method.enable_ctrlc_handler);
|
||||||
|
//! - Control your
|
||||||
|
//! [default](struct.DispatcherBuilder.html#method.default_handler) and
|
||||||
|
//! [error](struct.DispatcherBuilder.html#method.error_handler) handlers;
|
||||||
|
//! - Use [dialogues](dialogue/index.html).
|
||||||
|
//! - Use [`dptree`]-related functionality.
|
||||||
|
//! - Probably more.
|
||||||
|
//!
|
||||||
|
//! Thus, REPLs are good for simple bots and rapid prototyping, but for more
|
||||||
|
//! involved scenarios, we recommend using [`DispatcherBuilder`]/[`Dispatcher`]
|
||||||
|
//! together with [`dptree`].
|
||||||
|
//!
|
||||||
//! [`examples/purchase.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/purchase.rs
|
//! [`examples/purchase.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/purchase.rs
|
||||||
//! [`Update::filter_message`]: crate::types::Update::filter_message
|
//! [`Update::filter_message`]: crate::types::Update::filter_message
|
||||||
//! [`Update::filter_callback_query`]: crate::types::Update::filter_callback_query
|
//! [`Update::filter_callback_query`]: crate::types::Update::filter_callback_query
|
||||||
//! [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern
|
//! [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern
|
||||||
//! [dependency injection (DI)]: https://en.wikipedia.org/wiki/Dependency_injection
|
//! [dependency injection (DI)]: https://en.wikipedia.org/wiki/Dependency_injection
|
||||||
//! [`examples/dispatching_features.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/dispatching_features.rs
|
//! [`examples/dispatching_features.rs`]: https://github.com/teloxide/teloxide/blob/master/examples/dispatching_features.rs
|
||||||
|
//! [`Update`]: crate::types::Update
|
||||||
|
|
||||||
#[cfg(all(feature = "ctrlc_handler"))]
|
#[cfg(all(feature = "ctrlc_handler"))]
|
||||||
pub mod repls;
|
pub mod repls;
|
||||||
|
|
|
@ -27,6 +27,9 @@ use std::{
|
||||||
};
|
};
|
||||||
|
|
||||||
/// The builder for [`Dispatcher`].
|
/// The builder for [`Dispatcher`].
|
||||||
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](../dispatching/index.html#dispatching-or-repls)
|
||||||
pub struct DispatcherBuilder<R, Err, Key> {
|
pub struct DispatcherBuilder<R, Err, Key> {
|
||||||
bot: R,
|
bot: R,
|
||||||
dependencies: DependencyMap,
|
dependencies: DependencyMap,
|
||||||
|
@ -176,6 +179,9 @@ where
|
||||||
/// determine a chat ID of an incoming update, it will be handled concurrently.
|
/// determine a chat ID of an incoming update, it will be handled concurrently.
|
||||||
/// Note that this behaviour can be altered with [`distribution_function`].
|
/// Note that this behaviour can be altered with [`distribution_function`].
|
||||||
///
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](../dispatching/index.html#dispatching-or-repls)
|
||||||
|
///
|
||||||
/// [`distribution_function`]: DispatcherBuilder::distribution_function
|
/// [`distribution_function`]: DispatcherBuilder::distribution_function
|
||||||
pub struct Dispatcher<R, Err, Key> {
|
pub struct Dispatcher<R, Err, Key> {
|
||||||
bot: R,
|
bot: R,
|
||||||
|
|
|
@ -18,6 +18,9 @@ use teloxide_core::requests::Requester;
|
||||||
/// supply dependencies or describe more complex dispatch logic, please use
|
/// supply dependencies or describe more complex dispatch logic, please use
|
||||||
/// [`Dispatcher`].
|
/// [`Dispatcher`].
|
||||||
///
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](dispatching/index.html#dispatching-or-repls)
|
||||||
|
///
|
||||||
/// ## Caution
|
/// ## Caution
|
||||||
///
|
///
|
||||||
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
||||||
|
@ -58,6 +61,9 @@ where
|
||||||
/// supply dependencies or describe more complex dispatch logic, please use
|
/// supply dependencies or describe more complex dispatch logic, please use
|
||||||
/// [`Dispatcher`].
|
/// [`Dispatcher`].
|
||||||
///
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](dispatching/index.html#dispatching-or-repls)
|
||||||
|
///
|
||||||
/// ## Caution
|
/// ## Caution
|
||||||
///
|
///
|
||||||
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
||||||
|
|
|
@ -14,6 +14,9 @@ use teloxide_core::requests::Requester;
|
||||||
/// REPLs are meant only for simple bots and rapid prototyping. If you need to
|
/// REPLs are meant only for simple bots and rapid prototyping. If you need to
|
||||||
/// supply dependencies or describe more complex dispatch logic, please use
|
/// supply dependencies or describe more complex dispatch logic, please use
|
||||||
/// [`Dispatcher`].
|
/// [`Dispatcher`].
|
||||||
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](dispatching/index.html#dispatching-or-repls)
|
||||||
///
|
///
|
||||||
/// ## Caution
|
/// ## Caution
|
||||||
///
|
///
|
||||||
|
@ -44,6 +47,9 @@ where
|
||||||
/// supply dependencies or describe more complex dispatch logic, please use
|
/// supply dependencies or describe more complex dispatch logic, please use
|
||||||
/// [`Dispatcher`].
|
/// [`Dispatcher`].
|
||||||
///
|
///
|
||||||
|
/// See also: ["Dispatching or
|
||||||
|
/// REPLs?"](dispatching/index.html#dispatching-or-repls)
|
||||||
|
///
|
||||||
/// # Caution
|
/// # Caution
|
||||||
///
|
///
|
||||||
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
/// **DO NOT** use this function together with [`Dispatcher`] and other REPLs,
|
||||||
|
|
Loading…
Reference in a new issue