Struct tgbot::types::ReplyKeyboardMarkup

pub struct ReplyKeyboardMarkup { /* private fields */ }

Represents a custom keyboard with reply options.

Implementations

impl ReplyKeyboardMarkup

pub fn add_row<T>(self, value: T) -> Self

where T: IntoIterator<Item = KeyboardButton>,

Adds a row to the markup.

Arguments

• value - The row to add.

pub fn with_input_field_placeholder<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new input field placeholder.

Arguments

• value - The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

pub fn with_one_time_keyboard(self, value: bool) -> Self

Sets a new value for an one_time_keyboard flag.

Arguments

• value - Indicates whether to request clients to hide the keyboard as soon as it’s been used; default - false.

The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again.

pub fn with_is_persistent(self, value: bool) -> Self

Sets a new value for an is_persistent flag.

Arguments

• value - Indicates whether to request clients to always show the keyboard when the regular keyboard is hidden.

Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

pub fn with_resize_keyboard(self, value: bool) -> Self

Sets a new value for a resize_keyboard flag.

Arguments

• value - Indicates whether to request clients to resize the keyboard vertically for optimal fit.

E.g., make the keyboard smaller if there are just two rows of buttons. Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.

pub fn with_selective(self, value: bool) -> Self

Sets a new value for a selective flag.

Arguments

• value - Indicates whether to show the keyboard to specific users only.

Targets:

1. users that are @mentioned in the text of the crate::types::Message object.
2. if the bot message is a reply (has reply_to_message_id), sender of the original message.

Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

Trait Implementations

impl Clone for ReplyKeyboardMarkup

fn clone(&self) -> ReplyKeyboardMarkup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReplyKeyboardMarkup

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

Formats the value using the given formatter.

impl Default for ReplyKeyboardMarkup

fn default() -> ReplyKeyboardMarkup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReplyKeyboardMarkup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, B> From<A> for ReplyKeyboardMarkup

where A: IntoIterator<Item = B>, B: IntoIterator<Item = KeyboardButton>,

fn from(value: A) -> ReplyKeyboardMarkup

Converts to this type from the input type.

impl From<ReplyKeyboardMarkup> for ReplyMarkup

fn from(original: ReplyKeyboardMarkup) -> ReplyMarkup

Converts to this type from the input type.

impl PartialEq for ReplyKeyboardMarkup

fn eq(&self, other: &ReplyKeyboardMarkup) -> 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 ReplyKeyboardMarkup

fn partial_cmp(&self, other: &ReplyKeyboardMarkup) -> 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 ReplyKeyboardMarkup

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 ReplyKeyboardMarkup