Skip to main content

telegram_rich/
limits.rs

1//! Official rich message limits.
2
3/// Limits enforced by Telegram on rich messages.
4///
5/// [`Limits::TELEGRAM`] holds the official values documented in
6/// [Rich Message Limits](https://core.telegram.org/bots/api#rich-message-formatting-options).
7/// Use stricter values to keep a safety margin.
8#[derive(Debug, Clone, Copy, PartialEq, Eq)]
9pub struct Limits {
10    /// Maximum number of characters of text, including formula sources.
11    pub max_chars: usize,
12    /// Maximum number of blocks, including nested blocks, list items, table
13    /// rows, quotation blocks and details blocks.
14    pub max_blocks: usize,
15    /// Maximum nesting depth of formatting and blocks.
16    pub max_depth: usize,
17    /// Maximum number of media attachments.
18    pub max_media: usize,
19    /// Maximum number of columns in a table.
20    pub max_table_columns: usize,
21}
22
23impl Limits {
24    /// Official limits as of Bot API 10.4.
25    pub const TELEGRAM: Limits = Limits {
26        max_chars: 32_768,
27        max_blocks: 500,
28        max_depth: 16,
29        max_media: 50,
30        max_table_columns: 20,
31    };
32}
33
34impl Default for Limits {
35    fn default() -> Self {
36        Self::TELEGRAM
37    }
38}
39
40/// Measured size of a document, comparable against [`Limits`].
41#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
42pub struct Stats {
43    /// Number of text characters.
44    pub chars: usize,
45    /// Number of blocks.
46    pub blocks: usize,
47    /// Maximum nesting depth.
48    pub depth: usize,
49    /// Number of media attachments.
50    pub media: usize,
51    /// Maximum number of columns in any table.
52    pub max_table_columns: usize,
53}
54
55impl Stats {
56    /// Returns `true` if all values are within `limits`.
57    pub fn fits(&self, limits: &Limits) -> bool {
58        self.chars <= limits.max_chars
59            && self.blocks <= limits.max_blocks
60            && self.depth <= limits.max_depth
61            && self.media <= limits.max_media
62            && self.max_table_columns <= limits.max_table_columns
63    }
64}