blazegram 0.4.2

Telegram bot framework: clean chats, zero garbage, declarative screens, pure Rust MTProto.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

#![doc = include_str!("../README.md")]
// All public items are documented as of 0.4.0.
#![warn(missing_docs)]
#![allow(clippy::too_many_arguments, clippy::module_name_repetitions)]

// ─── Macros (must come first — macro_rules! are order-dependent) ───

/// Ergonomic handler macros (`handler!`, `form_handler!`) and BotApi delegation macros.
#[macro_use]
pub mod macros;

// ─── Core types & errors ───

/// Error types for API calls and handler logic.
pub mod error;
/// Core types: ChatId, MessageId, Screen identifiers, message content, parsed updates.
pub mod types;

// ─── Screen system (the heart of Blazegram) ───

/// Virtual Chat Differ — computes minimal API operations for screen transitions.
pub mod differ;
/// Diff operation executor — applies edit/delete/send with retry and fallback.
pub mod executor;
/// Inline keyboard builder with buttons, rows, grids, navigation.
pub mod keyboard;
/// Markup processor: `*bold*` `_italic_` → Telegram HTML, plus HTML builder helpers and `escape()`.
pub mod markup;
/// Screen builder — declarative UI for chat messages.
pub mod screen;

// ─── Runtime ───

/// grammers MTProto adapter implementing [`BotApi`](crate::bot_api::BotApi).
///
/// Split into sub-modules for send, media, admin, settings, forum, and stars operations.
pub mod adapter;
/// `BotApi` trait — 60+ async methods abstracting Telegram API calls.
pub mod bot_api;
/// Re-export for backward compatibility with pre-0.4 code that used
/// `blazegram::grammers_adapter::*`.
pub mod grammers_adapter {
    pub use crate::adapter::*;
}
/// App builder and main event loop.
pub mod app;
/// Handler context — the single object handlers interact with.
pub mod ctx;
/// File-backed session — MemorySession + JSON persistence. Zero SQLite.
pub mod file_session;
/// Command/callback/input router with prefix matching.
pub mod router;
/// Per-chat lock guaranteeing sequential update processing.
pub mod serializer;
/// State storage trait + in-memory store with snapshot support.
pub mod state;
/// Raw grammers Update → IncomingUpdate parser (isolates TL pattern matching).
pub(crate) mod update_parser;

// ─── Features ───

/// Broadcast messages to multiple chats.
pub mod broadcast;
/// Branching conversation system — multi-step dialogues with conditional flow.
pub mod conversation;
/// Multi-step form wizards with validation.
pub mod form;
/// FTL-based i18n with `{ $var }` interpolation.
pub mod i18n;
/// Inline query results with builder API.
pub mod inline;
/// Paginated lists with auto-generated navigation buttons.
pub mod pagination;
/// Progressive screen updates (streaming, progress bars). Auto-cancelled on navigate().
pub mod progressive;
/// Delayed action scheduler — fire callbacks after a duration.
pub mod scheduler;
/// Template engine: `{{ var }}`, `{% if %}`, `{% for %}`.
pub mod template;

// ─── Infrastructure ───

/// File ID cache — avoid re-uploading the same media.
pub mod file_cache;
/// Prometheus-style counters and histograms.
pub mod metrics;
/// Middleware trait + built-in logging, analytics, throttle.
pub mod middleware;
/// Token-bucket rate limiter with automatic FLOOD_WAIT handling.
pub mod rate_limiter;
/// Pure-Rust persistent state store (redb). Zero C deps, no SQLite conflicts.
/// Requires the `redb` feature (enabled by default).
#[cfg(feature = "redb")]
pub mod redb_store;

// ─── Testing ───

/// Mock BotApi for unit tests without Telegram.
pub mod mock;
/// TestApp harness for integration-style tests.
pub mod testing;

// ─── Prelude ───

/// Re-exports everything you need: `use blazegram::prelude::*;`
pub mod prelude;

// ─── Optional stores ───

/// Redis-backed state store (requires `redis` feature).
#[cfg(feature = "redis")]
pub mod redis_store;