rust-tg-bot-raw 1.0.0-rc.1

Pure Telegram Bot API types and methods for Rust -- a faithful port of python-telegram-bot's core layer
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

use serde::{Deserialize, Serialize};

use super::keyboard_button_poll_type::KeyboardButtonPollType;
use super::keyboard_button_request::{
    KeyboardButtonRequestChat, KeyboardButtonRequestManagedBot, KeyboardButtonRequestUsers,
};
use super::web_app_info::WebAppInfo;

/// One button of a reply keyboard.
///
/// For simple text buttons `text` is the only field needed; the other optional
/// fields are mutually exclusive and enable richer interactions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
#[non_exhaustive]
pub struct KeyboardButton {
    /// Label text shown on the button.
    pub text: String,

    /// If `true`, the user's phone number is sent when the button is pressed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_contact: Option<bool>,

    /// If `true`, the user's current location is sent when the button is pressed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_location: Option<bool>,

    /// If set, the user is asked to create a poll and send it to the bot.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_poll: Option<KeyboardButtonPollType>,

    /// If set, the described Web App is launched when the button is pressed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub web_app: Option<WebAppInfo>,

    /// If set, pressing the button opens a user-selection list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_users: Option<KeyboardButtonRequestUsers>,

    /// If set, pressing the button opens a chat-selection list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_chat: Option<KeyboardButtonRequestChat>,

    /// If specified, pressing the button will ask the user to create and share a bot
    /// that will be managed by the current bot. Available in private chats only.
    ///
    /// Added in Bot API 9.6.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_managed_bot: Option<KeyboardButtonRequestManagedBot>,

    /// Visual style for the button: `"primary"`, `"success"`, or `"danger"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub style: Option<String>,

    /// Unique identifier of the custom emoji shown before the button text.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub icon_custom_emoji_id: Option<String>,
}

impl KeyboardButton {
    /// Create a simple text button.
    pub fn text(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            ..Default::default()
        }
    }

    /// Create a button that requests the user's phone contact when pressed.
    pub fn request_contact(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            request_contact: Some(true),
            ..Default::default()
        }
    }

    /// Create a button that requests the user's location when pressed.
    pub fn request_location(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            request_location: Some(true),
            ..Default::default()
        }
    }
}

impl From<&str> for KeyboardButton {
    fn from(text: &str) -> Self {
        Self::text(text)
    }
}

impl From<String> for KeyboardButton {
    fn from(text: String) -> Self {
        Self::text(text)
    }
}