Struct KeyboardButton 

#[non_exhaustive]
pub struct KeyboardButton {
    pub text: String,
    pub request_contact: Option<bool>,
    pub request_location: Option<bool>,
    pub request_poll: Option<KeyboardButtonPollType>,
    pub web_app: Option<WebAppInfo>,
    pub request_users: Option<KeyboardButtonRequestUsers>,
    pub request_chat: Option<KeyboardButtonRequestChat>,
    pub request_managed_bot: Option<KeyboardButtonRequestManagedBot>,
    pub style: Option<String>,
    pub icon_custom_emoji_id: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

Label text shown on the button.

request_contact: Option<bool>

If true, the user’s phone number is sent when the button is pressed.

request_location: Option<bool>

If true, the user’s current location is sent when the button is pressed.

request_poll: Option<KeyboardButtonPollType>

If set, the user is asked to create a poll and send it to the bot.

web_app: Option<WebAppInfo>

If set, the described Web App is launched when the button is pressed.

request_users: Option<KeyboardButtonRequestUsers>

If set, pressing the button opens a user-selection list.

request_chat: Option<KeyboardButtonRequestChat>

If set, pressing the button opens a chat-selection list.

request_managed_bot: Option<KeyboardButtonRequestManagedBot>

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.

style: Option<String>

Visual style for the button: "primary", "success", or "danger".

icon_custom_emoji_id: Option<String>

Unique identifier of the custom emoji shown before the button text.

Implementations

impl KeyboardButton

pub fn text(text: impl Into<String>) -> KeyboardButton

Create a simple text button.

pub fn request_contact(text: impl Into<String>) -> KeyboardButton

Create a button that requests the user’s phone contact when pressed.

pub fn request_location(text: impl Into<String>) -> KeyboardButton

Create a button that requests the user’s location when pressed.

Trait Implementations

impl Clone for KeyboardButton

fn clone(&self) -> KeyboardButton

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyboardButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for KeyboardButton

fn default() -> KeyboardButton

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyboardButton

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyboardButton, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for KeyboardButton

fn from(text: &str) -> KeyboardButton

Converts to this type from the input type.

impl From<String> for KeyboardButton

fn from(text: String) -> KeyboardButton

Converts to this type from the input type.

impl PartialEq for KeyboardButton

fn eq(&self, other: &KeyboardButton) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KeyboardButton

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyboardButton