Struct tgbot::types::InlineKeyboardButton

source ·
pub struct InlineKeyboardButton { /* private fields */ }
Expand description

Represents a button of an inline keyboard.

Implementations§

source§

impl InlineKeyboardButton

source

pub fn for_callback_data<A, B>(text: A, data: B) -> Self
where A: Into<String>, B: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Data to be sent in a callback query to the bot when button is pressed; 1-64 bytes.
source

pub fn for_callback_data_struct<A, B>( text: A, data: &B ) -> Result<Self, InlineKeyboardError>
where A: Into<String>, B: Serialize,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Data to be sent in a callback query.

Same as Self::for_callback_data, but takes a serializable type.

Data will be serialized using serde_json.

source

pub fn for_callback_game<T>(text: T) -> Self
where T: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.

A game will be launched when the user presses the button.

§Notes

This type of button must always be the first button in the first row.

source

pub fn for_login_url<A, B>(text: A, data: B) -> Self
where A: Into<String>, B: Into<LoginUrl>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - An HTTPs URL used to automatically authorize the user.

Can be used as a replacement for the Telegram Login Widget.

source

pub fn for_pay<T>(text: T) -> Self
where T: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.

Represents a pay button.

https://core.telegram.org/bots/payments

§Notes

This type of button must always be the first button in the first row and can only be used in invoice messages.

source

pub fn for_switch_inline_query<A, B>(text: A, data: B) -> Self
where A: Into<String>, B: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Text of an inline query.

Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field.

Can be empty, in which case just the bot’s username will be inserted.

§Notes

This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it.

Especially useful when combined with switch_pm… actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.

source

pub fn for_switch_inline_query_chosen_chat<T>( text: T, data: SwitchInlineQueryChosenChat ) -> Self
where T: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Inline query parameters.

Pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot username and the specified inline query in the input field.

source

pub fn for_switch_inline_query_current_chat<A, B>(text: A, data: B) -> Self
where A: Into<String>, B: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Text of an inline query.

Pressing the button will insert the bot‘s username and the specified inline query in the current chat’s input field.

Can be empty, in which case only the bot’s username will be inserted This offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options.

source

pub fn for_url<A, B>(text: A, data: B) -> Self
where A: Into<String>, B: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button
  • data - HTTP or tg:// URL to be opened when button is pressed.
source

pub fn for_web_app<T>(text: T, data: WebAppInfo) -> Self
where T: Into<String>,

Creates a new InlineKeyboardButton.

§Arguments
  • text - Text of the button.
  • data - Description of the Web App that will be launched when the user presses the button.
source

pub fn button_type(&self) -> &InlineKeyboardButtonType

Returns the type of the button.

source

pub fn text(&self) -> &str

Returns the text of the button.

Trait Implementations§

source§

impl Clone for InlineKeyboardButton

source§

fn clone(&self) -> InlineKeyboardButton

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for InlineKeyboardButton

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for InlineKeyboardButton

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq for InlineKeyboardButton

source§

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

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

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.
source§

impl Serialize for InlineKeyboardButton

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for InlineKeyboardButton

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromRef<T> for T
where T: Clone,

source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,