⚡rustygram

⚡rustygram 是一个最小化和极快的 Rust 语言 Telegram 通知框架，它抽象化了 Telegram API 的复杂性，使得您的应用不需要担心底层实现。

亮点

• 轻松将 rustygram 集成到您的 Rust 应用程序中，快速向 Telegram 机器人、群组和频道发送消息。

• 以可靠的方式发送异步通知。

API概览

• create_bot - 创建一个包含 Telegram 机器人令牌和目标 chat_id 的机器人实例
• send_message - 调用 Telegram 机器人的 API sendMessage 以异步方式发送消息

示例

简单发送

fn main() {
 let instance = rustygram::create_bot("123456:123456", "-1000000");
 if let Err(_) = rustygram::send_message(&instance, "Hello world", None) {
  // error handling here...
 }
}

以 MarkdownV2 或 HTML 风格发送消息

以 MarkdownV2 发送消息

use rustygram::types::{SendMessageOption, SendMessageParseMode};

fn main() {
 let instance = rustygram::create_bot("16", "-1s00");
 let option = SendMessageOption { parse_mode: Some(SendMessageParseMode::MarkdownV2) };

 // note on two spaces at the end of the line for a new line in markdown
 if let Err(_) = rustygram::send_message(&instance,
r#"__Hello world__
`Tap to copy this text`
Visit my [website](https://yong-kang.super.site/)"#, Some(option)) {
  // error handling here...
 }
}

以 HTML 发送消息

use rustygram::types::{SendMessageOption, SendMessageParseMode};

fn main() {
 let instance = rustygram::create_instance("189:blablabla", "-10");
 let option = SendMessageOption { parse_mode: Some(SendMessageParseMode::HTML) };

 if let Err(_) = rustygram::send_message(&instance,
r#"<u>Hello world</u>
<code>Tap to copy this text</code>
Visit my <a href="https://yong-kang.super.site/">website</a>"#, Some(option)) {
  // error handling here...
 }
}

作为类设置和测试

• 查看 example.rs，其中包含带有测试的具体示例

发送 CSV 文件

use rustygram::types::{SendMessageOption, SendMessageParseMode};

fn main() {
  let instance = rustygram::create_bot("189:blablabla", "-10");
  let option = SendMessageOption { parse_mode: Some(SendMessageParseMode::MarkdownV2) };

  if let Err(_) = rustygram::send_csv(&instance, "example.csv", Some(option)) {
    // error handling here...
  }
}
```

- Refer to tests.rs for more reference on how to send a CSV file

## Setting up your environment

1. [Download Rust](http://rustup.rs/).
2. Create a new bot using [@Botfather](https://t.me/botfather) to get a token in the format `189:blablabla`.
3. Initialise the `BOT_TOKEN` environmental variable to your token:

```bash
# Unix-like
$ export BOT_TOKEN=<Your token here>

# Windows command line
$ set BOT_TOKEN=<Your token here>

# Windows PowerShell
$ $env:BOT_TOKEN=<Your token here>

4. 确保您的 Rust 编译器是最新的（目前 rustygram 需要 rustc 至少版本 1.68）

# If you're using stable
$ rustup update stable
$ rustup override set stable

# If you're using nightly
$ rustup update nightly
$ rustup override set nightly

5. 运行 cargo new my_bot，进入目录并在您的 Cargo.toml 中放入以下行

[dependencies]
rustygram = "0.1"
log = "0.4"
pretty_env_logger = "0.4"
tokio = { version =  "1.8", features = ["rt-multi-thread", "macros"] }

测试

您可以通过定义以下两个环境变量进行测试

• TEST_BOT_TOKEN - Telegram 机器人的 token
• TEST_CHAT_ID - Telegram 机器人的 chat id

然后执行

cargotest

一些测试将代表该 Telegram 机器人向指定的 chat id 发送单条或多条消息。请参阅 src/tests.rs。

注意

您可以使用此 Telegram 机器人 @username_to_id_bot 来获取您的 Telegram 频道的 chat_id。

贡献

参见 CONTRIBUTING.md。

致谢

本项目深受teloxide的启发。然而，它并不是teloxide的分支，而是为了使它在Telegram发送通知用例中更加精简和快速，而进行了完全重写。

简约的设计灵感来源于rustelebot，但采用了更模块化和可扩展的设计，同时将底层库改为更现代的库。

许可协议

MIT，Chia Yong Kang