Skip to main content

TelegramBot

Struct TelegramBot 

Source
pub struct TelegramBot { /* private fields */ }
Expand description

Telegram bot builder

Create a bot with command and button handlers, then either call build() for a webhook endpoint or run() for long polling.

§Example

use botkit_core::User;
use botkit_telegram::{TelegramBot, TelegramWebhook};

// Simple handler - no Context needed!
async fn ping() -> &'static str {
    "Pong!"
}

// With extractors
async fn greet(user: User) -> String {
    format!("Hello, {}!", user.name)
}

// Return TelegramWebhook directly - it implements Endpoint
#[skyzen::main]
fn main() -> TelegramWebhook {
    TelegramBot::new(token)
        .command("ping", ping)
        .command("greet", greet)
        .build()
}

Implementations§

Source§

impl TelegramBot

Source

pub fn new(token: impl Into<String>) -> Self

Create a new Telegram bot

Source

pub fn command<H, Args>(self, name: impl Into<String>, handler: H) -> Self
where H: IntoHandler<Args>,

Register a command handler (e.g., /start, /help)

Source

pub fn command_with_description<H, Args>( self, name: impl Into<String>, description: impl Into<String>, handler: H, ) -> Self
where H: IntoHandler<Args>,

Register a command handler with description

The description appears in Telegram’s command menu (slash command suggestions).

Source

pub fn button<H, Args>(self, pattern: impl Into<String>, handler: H) -> Self
where H: IntoHandler<Args>,

Register a button handler (callback query data pattern)

Pattern can end with * for prefix matching (e.g., “confirm_*”)

Source

pub fn message<H, Args>(self, handler: H) -> Self
where H: IntoHandler<Args>,

Register a message handler

Source

pub fn fallback<H, Args>(self, handler: H) -> Self
where H: IntoHandler<Args>,

Register a handler for events nothing else claimed

Unregistered commands and unmatched callbacks reach the fallback rather than being dropped. See BotBuilder::fallback.

Source

pub fn skip_command_registration(self) -> Self

Stop publishing the registered commands to Telegram on startup

On by default for TelegramBot::run; webhook mode never registers commands, since build() does no I/O.

Source

pub fn build(self) -> TelegramWebhook

Build the webhook handler (for use with skyzen’s Endpoint)

Registering the command menu is a network call, so webhook deployments should call TelegramClient::set_my_commands themselves at startup; TelegramBot::commands renders the list to pass it.

Source

pub fn commands(&self) -> Vec<BotCommand>

The command menu entries implied by the registered handlers

Trait Implementations§

Source§

impl Bot for TelegramBot

Source§

async fn run_until(self, shutdown: Shutdown) -> Result<(), BotError>

Run the bot until shutdown fires or a fatal error occurs Read more
Source§

fn run(self) -> impl BotFutureBounds

Run the bot until a fatal error occurs Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ChatActionSenderBounds for T
where T: Send + Sync + ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more