17 releases
0.1.17 | Oct 3, 2023 |
---|---|
0.1.14 | Apr 21, 2023 |
0.1.13 | Mar 21, 2023 |
0.1.9 | Nov 22, 2022 |
0.1.3 | Jun 6, 2020 |
#782 in Web programming
106 downloads per month
485KB
7.5K
SLoC
telexide
Telexide is an easy to use library for making a telegram bot, built on tokio and hyper.
View the examples on how to make and structure a bot.
Use the ClientBuilder
to easily create a Client
object to your
preferences and register commands with the create_framework
macro and/or
register your own update handlers, before running Client::start
to start
your bot. All of this is designed to be highly customisable. For further
information about the client, please see the client's module-level
documentation.
API calls are easy to make using the APIClient
and the api data models,
or create and use your own api client by implementing the API
trait. For
further information about the api client, please see the api's module-level
documentation.
A default command framework is provided using the Framework
object,
providing easy handling of incoming telegram bot commands
sent by users of your bot. For further information about the framework,
please see the framework's module-level documentation.
Example Bot
A basic ping-pong bot can be written like:
use std::env;
use telexide::{api::types::SendMessage, prelude::*};
#[command(description = "just a ping-pong command")]
async fn ping(context: Context, message: Message) -> CommandResult {
context
.api
.send_message(SendMessage::new(message.chat.get_id().into(), "pong"))
.await?;
Ok(())
}
#[tokio::main]
async fn main() -> telexide::Result<()> {
let token = env::var("BOT_TOKEN").expect("no token environment variable set");
let bot_name = "ping-pong";
ClientBuilder::new()
.set_token(&token)
.set_framework(create_framework!(bot_name, ping))
.build()
.start()
.await
}
For more examples, please see the examples directory.
Crate Features
- Supports all of the telegram bot API, up to and including version 6.9
- easy to use and customisable client
- long-polling based update handling
- set your own timeout
- set your own limit for updates gotten at once
- easy to use, macro-based command framework
- easy to use and heavily customisable api client
- use your own hyper client
- use your own api struct so you control the get and post methods
- includes all telegram api endpoints
- webhook based update handling
- builder methods for creating all api call payloads
Planned
- choosing what you want from the lib using feature flags
- subscribe to non-message events using command (or similar) framework
- run command on receiving an inline query or answer to one
- run command on receiving a poll that matches your requirements
- wait_for style Context method to wait for an update matching your criteria
- methods on models for easier calling of API endpoints (like
ChatMember::kick
)
Installation
Add the following to your Cargo.toml
file:
[dependencies]
telexide = "0.1.17"
Feature Flags
Telexide uses a set of feature flags to allow switching between rustls and native-tls for tls support. In the future flags may be added to enable/disable optional parts of the crate.
rustls
: Makes the api client usehyper-rustls
to create the tls connector. Enabled by default.native-tls
: Makes the api client usehyper-tls
to create the tls connector. Overwrites therustls
feature if enabled.
Supported Rust Versions
The minimum supported version is 1.64. The current Telexide version is not guaranteed to build on Rust versions earlier than the minimum supported version.
Dependencies
~9–22MB
~343K SLoC