Struct teloxide::types::KeyboardMarkup

pub struct KeyboardMarkup {
    pub keyboard: Vec<Vec<KeyboardButton, Global>, Global>,
    pub is_persistent: bool,
    pub resize_keyboard: Option<bool>,
    pub one_time_keyboard: Option<bool>,
    pub input_field_placeholder: Option<String>,
    pub selective: Option<bool>,
}

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

The official docs.

Fields

keyboard: Vec<Vec<KeyboardButton, Global>, Global>

Array of button rows, each represented by an Array of KeyboardButton objects

is_persistent: bool

Requests 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.

resize_keyboard: Option<bool>

Requests 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.

one_time_keyboard: Option<bool>

Requests clients to hide the keyboard as soon as it’s been used. 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. Defaults to false.

input_field_placeholder: Option<String>

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

selective: Option<bool>

Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s 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.

Implementations

impl KeyboardMarkup

pub fn new<K>(keyboard: K) -> KeyboardMarkupwhere
    K: IntoIterator,
    <K as IntoIterator>::Item: IntoIterator<Item = KeyboardButton>,

pub fn append_row<R>(self, buttons: R) -> KeyboardMarkupwhere
    R: IntoIterator<Item = KeyboardButton>,

pub fn append_to_row(self, index: usize, button: KeyboardButton) -> KeyboardMarkup

pub fn persistent(self) -> KeyboardMarkup

Sets is_persistent to true.

pub fn resize_keyboard<T>(self, val: T) -> KeyboardMarkupwhere
    T: Into<Option<bool>>,

pub fn one_time_keyboard<T>(self, val: T) -> KeyboardMarkupwhere
    T: Into<Option<bool>>,

pub fn input_field_placeholder<T>(self, val: T) -> KeyboardMarkupwhere
    T: Into<Option<String>>,

pub fn selective<T>(self, val: T) -> KeyboardMarkupwhere
    T: Into<Option<bool>>,

Trait Implementations

impl Clone for KeyboardMarkup

fn clone(&self) -> KeyboardMarkup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardMarkup

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

Formats the value using the given formatter.

impl Default for KeyboardMarkup

fn default() -> KeyboardMarkup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyboardMarkup

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

Deserialize this value from the given Serde deserializer.

impl From<KeyboardMarkup> for ReplyMarkup

fn from(original: KeyboardMarkup) -> ReplyMarkup

Converts to this type from the input type.

impl Hash for KeyboardMarkup

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<KeyboardMarkup> for KeyboardMarkup

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

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 Eq for KeyboardMarkup

impl StructuralEq for KeyboardMarkup

impl StructuralPartialEq for KeyboardMarkup