Struct tgbot::types::KeyboardButton

pub struct KeyboardButton { /* private fields */ }

Represents a button of the reply keyboard.

Implementations

impl KeyboardButton

pub fn new<T>(text: T) -> Self

where T: Into<String>,

Creates a new KeyboardButton.

Arguments

• text - Text of the button.

If none of the optional fields are used, it will be sent as a message when the button is pressed.

pub fn with_request_chat(self, value: KeyboardButtonRequestChat) -> Self

Changes button type to a chat request.

Arguments

• value - Criteria used to request a suitable chat.

If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a crate::types::MessageData::ChatShared message.

Available in private chats only.

pub fn with_request_contact(self) -> Self

Changes button type to a contact request.

The user’s phone number will be sent as a contact when the button is pressed.

Available in private chats only.

pub fn with_request_location(self) -> Self

Changes button type to a location request.

The user’s current location will be sent when the button is pressed.

Available in private chats only.

pub fn with_request_poll<T>(self, button_type: T) -> Self

where T: Into<KeyboardButtonPollType>,

Changes button type to a poll request.

Arguments

• value - Type of a poll.

The user will be asked to create a poll and send it to the bot when the button is pressed. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

Available in private chats only.

pub fn with_request_users(self, value: KeyboardButtonRequestUsers) -> Self

Changes button type to a user request.

Arguments

• value - Criteria used to request a suitable user.

If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a crate::types::MessageData::UsersShared message.

Available in private chats only.

pub fn with_web_app(self, web_app_info: WebAppInfo) -> Self

Changes button type to a web app.

Arguments

• value - The Web App that will be launched when the button is pressed.

The Web App will be able to send a crate::types::MessageData::WebAppData message.

Available in private chats only.

Trait Implementations

impl Clone for KeyboardButton

fn clone(&self) -> KeyboardButton

Returns a copy 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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyboardButton

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for KeyboardButton

fn partial_cmp(&self, other: &KeyboardButton) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for KeyboardButton

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyboardButton