https://github.com/bytesnake/telebot

Write Telegram bots in Rust with Tokio and Futures
https://github.com/bytesnake/telebot

async bot chat rust telegram telegram-bot

Last synced: about 2 months ago
JSON representation

Write Telegram bots in Rust with Tokio and Futures

• Host: GitHub
• URL: https://github.com/bytesnake/telebot
• Owner: bytesnake
• License: other
• Created: 2016-12-31T11:01:46.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-02T16:52:22.000Z (over 2 years ago)
• Last Synced: 2024-07-14T22:03:45.210Z (2 months ago)
• Topics: async, bot, chat, rust, telegram, telegram-bot
• Language: Rust
• Homepage:
• Size: 536 KB
• Stars: 208
• Watchers: 5
• Forks: 33
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
Telebot - Telegram Bot Library for Rust

======================================

[![Travis Build Status](https://travis-ci.org/bytesnake/telebot.svg)](https://travis-ci.org/bytesnake/telebot)

[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bytesnake/telebot/blob/master/LICENSE)

[![Crates.io](https://img.shields.io/crates/v/telebot.svg)](https://crates.io/crates/telebot)

[![doc.rs](https://docs.rs/telebot/badge.svg)](https://docs.rs/telebot)

This library allows you to write a Telegram Bot in the Rust language. It's an almost complete wrapper for the Telegram Bot API and uses hyper to send requests to the Telegram server. Each Telegram function call returns a future which carries the actual bot and the answer. 

## Usage

Add this to your `Cargo.toml`

``` toml

[dependencies]

telebot = "0.3.1"

```

## How it works

This example shows the basic usage of the telebot library. It creates a new handler for a simple "/reply" command and replies the received text. The tokio eventloop polls every 200ms for new updates and matches them with the registered events. If the command matches with "/reply" it will call the function and execute the returned future.

``` rust

use telebot::Bot;

use futures::stream::Stream;

use std::env;

// import all available functions

use telebot::functions::*;

fn main() {

    // Create the bot

    let mut bot = Bot::new(&env::var("TELEGRAM_BOT_KEY").unwrap()).update_interval(200);

    // Register a reply command which answers a message

    let handle = bot.new_cmd("/reply")

        .and_then(|(bot, msg)| {

            let mut text = msg.text.unwrap().clone();

            if text.is_empty() {

                text = "".into();

            }

            bot.message(msg.chat.id, text).send()

        })

        .for_each(|_| Ok(()));

    bot.run_with(handle);

}

```

## Additional example

The former example was very simple with just one handler and no error handling. If you want to see a further explained and illustrated one, please see [here](example.md).

## Find a Telegram function in the source code

This crate uses custom derive to generate functions of the Telegram API. Therefore each complete function is described with a struct in [functions.rs](src/functions.rs) and the supplemental crate telebot-derive generates the complete signature. In order to find a function, the struct signature can be used. For example consider sendLocation:

``` rust

/// Use this method to send point on the map. On success, the sent Message is returned.

#[derive(TelegramFunction, Serialize)]

#[call = "sendLocation"]

#[answer = "Message"]

#[function = "location"]

pub struct SendLocation {

    chat_id: u32,

    latitude: f32,

    longitude: f32,

#[serde(skip_serializing_if="Option::is_none")]

    disable_notification: Option,

#[serde(skip_serializing_if="Option::is_none")]

    reply_to_message_id: Option,

#[serde(skip_serializing_if="Option::is_none")]

    reply_markup: Option

}

```

The field "function" defines the name of the function in the local API. Each optional field in the struct can be changed by calling an additional function with the name of the field.

So for example to send the location of Paris to chat 432432 without notification: `bot.location(432432, 48.8566, 2.3522).disable_notification(true).send() `

## License

Licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )

- MIT license ([LICENSE-MIT](LICENSE-MIT) or )

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally

submitted for inclusion in the work by you, as defined in the Apache-2.0

license, shall be dual licensed as above, without any additional terms or

conditions.