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

Quick fixes

Browse source
This commit is contained in:
Temirkhan Myrzamadi 2020-02-19 21:32:42 +06:00
parent e0d0e22ea6
commit 3308014694
4 changed files with 6 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -93,17 +93,6 @@ async fn main() {
```
<details>
<summary>Click here to run it!</summary>
```bash
git clone https://github.com/teloxide/teloxide.git
cd teloxide/examples/ping_pong_bot
TELOXIDE_TOKEN=<Your token here> cargo run
```
</details>
<div align="center">
<kbd>
<img src=https://github.com/teloxide/teloxide/raw/master/media/PING_PONG_BOT.png width="600" />
@ -161,17 +150,6 @@ async fn main() {
}
```
<details>
<summary>Click here to run it!</summary>
```bash
git clone https://github.com/teloxide/teloxide.git
cd teloxide/examples/simple_commands_bot
TELOXIDE_TOKEN=<Your token here> cargo run
```
</details>
<div align="center">
<kbd>
<img src=https://github.com/teloxide/teloxide/raw/master/media/SIMPLE_COMMANDS_BOT.png width="500"/>
@ -179,7 +157,6 @@ TELOXIDE_TOKEN=<Your token here> cargo run
<br/><br/>
</div>
See? The dispatcher gives us a stream of messages, so we can handle it as we want! Here we use our `.commands::<Command>()` and [`.for_each_concurrent()`](https://docs.rs/futures/0.3.4/futures/stream/trait.StreamExt.html#method.for_each_concurrent), but others are also available:
- [`.flatten()`](https://docs.rs/futures/0.3.4/futures/stream/trait.StreamExt.html#method.flatten)
- [`.left_stream()`](https://docs.rs/futures/0.3.4/futures/stream/trait.StreamExt.html#method.left_stream)
@ -261,17 +238,6 @@ async fn main() {
}
```
<details>
<summary>Click here to run it!</summary>
```bash
git clone https://github.com/teloxide/teloxide.git
cd teloxide/examples/guess_a_number_bot
TELOXIDE_TOKEN=<Your token here> cargo run
```
</details>
<div align="center">
<kbd>
<img src=https://github.com/teloxide/teloxide/raw/master/media/GUESS_A_NUMBER_BOT.png width="600" />

2
src/dispatching/dispatcher_handler_rx_ext.rs
View file

@ -5,7 +5,7 @@ use futures::{stream::BoxStream, Stream, StreamExt};
/// An extension trait to be used with [`DispatcherHandlerRx`].
///
/// [`DispatcherHandlerRx`]: crate:dispatching::DispatcherHandlerRx
/// [`DispatcherHandlerRx`]: crate::dispatching::DispatcherHandlerRx
pub trait DispatcherHandlerRxExt {
/// Extracts only text messages from this stream of arbitrary messages.
fn text_messages(

2
src/dispatching/mod.rs
View file

@ -20,7 +20,7 @@
//! ```
//!
//! When [`Update`] is received from Telegram, [`Dispatcher`] pushes it into an
//! appropriate handler. That's simple!
//! appropriate handler, depending on its kind. That's simple!
//!
//! **Note** that handlers must implement [`DispatcherHandler`], which means
//! that:

56
src/lib.rs
View file

@ -2,21 +2,7 @@
//! using the [`async`/`.await`] syntax in [Rust]. It handles all the difficult
//! stuff so you can focus only on your business logic.
//!
//! # Features
//! - **Type-safe.** teloxide leverages the Rust's type system with two serious
//! implications: resistance to human mistakes and tight integration with
//! IDEs. Write fast, avoid debugging as much as possible.
//!
//! - **Flexible API.** teloxide gives you the power of [streams]: you can
//! combine [all 30+ patterns] when working with updates from Telegram.
//!
//! - **Persistency.** By default, teloxide stores all user dialogues in RAM,
//! but you can store them somewhere else (for example, in DB) just by
//! implementing 2 functions.
//!
//! - **Convenient dialogues system.** Define a type-safe [finite automaton]
//! and transition functions to drive a user dialogue with ease (see [the
//! guess-a-number example](#guess-a-number) below).
//! See also [our GitHub repository](https://github.com/teloxide/teloxide).
//!
//! # Getting started
//! 1. Create a new bot using [@Botfather] to get a token in the format
@ -72,17 +58,6 @@
//! }
//! ```
//!
//! <details>
//! <summary>Click here to run it!</summary>
//!
//! ```text
//! git clone https://github.com/teloxide/teloxide.git
//! cd teloxide/examples/ping_pong_bot
//! TELOXIDE_TOKEN=<Your token here> cargo run
//! ```
//!
//! </details>
//!
//! <div align="center">
//! <kbd>
//! <img src=https://github.com/teloxide/teloxide/raw/master/media/PING_PONG_BOT.png width="600" />
@ -151,17 +126,6 @@
//! }
//! ```
//!
//! <details>
//! <summary>Click here to run it!</summary>
//!
//! ```text
//! git clone https://github.com/teloxide/teloxide.git
//! cd teloxide/examples/simple_commands_bot
//! TELOXIDE_TOKEN=<Your token here> cargo run
//! ```
//!
//! </details>
//!
//! <div align="center">
//! <kbd>
//! <img src=https://github.com/teloxide/teloxide/raw/master/media/SIMPLE_COMMANDS_BOT.png width="500"/>
@ -273,17 +237,6 @@
//! }
//! ```
//!
//! <details>
//! <summary>Click here to run it!</summary>
//!
//! ```text
//! git clone https://github.com/teloxide/teloxide.git
//! cd teloxide/examples/guess_a_number_bot
//! TELOXIDE_TOKEN=<Your token here> cargo run
//! ```
//!
//! </details>
//!
//! <div align="center">
//! <kbd>
//! <img src=https://github.com/teloxide/teloxide/raw/master/media/GUESS_A_NUMBER_BOT.png width="600" />
@ -301,9 +254,7 @@
//! (`Dialogue::Start` has `()`, `Dialogue::ReceiveAttempt` has `u8`).
//!
//! See [examples/dialogue_bot] to see a bit more complicated bot with
//! dialogues.
//!
//! # [More examples!](https://github.com/teloxide/teloxide/tree/master/examples)
//! dialogues. [See all examples](https://github.com/teloxide/teloxide/tree/master/examples).
//!
//! # Recommendations
//!
@ -347,8 +298,9 @@
//! [category theory]: https://en.wikipedia.org/wiki/Category_theory
//! [coproduct]: https://en.wikipedia.org/wiki/Coproduct
// https://github.com/teloxide/teloxide/raw/master/logo.svg doesn't work in html_logo_url, I don't know why.
#![doc(
html_logo_url = "https://github.com/teloxide/teloxide/raw/master/logo.svg",
html_logo_url = "https://github.com/teloxide/teloxide/raw/master/ICON.png",
html_favicon_url = "https://github.com/teloxide/teloxide/raw/master/ICON.png"
)]
#![allow(clippy::match_bool)]