Trait Payload

pub trait Payload {
    type Output;

    const NAME: &'static str;

    // Provided method
    fn timeout_hint(&self) -> Option<Duration> { ... }
}

Payload of a request.

Simply speaking, structures implementing this trait represent arguments of a Telegram bot API method.

Also, this trait provides some additional information needed to send a request to Telegram.

Required Associated Constants

const NAME: &'static str

Name of a Telegram method.

It is case insensitive, though must not include underscores. (e.g. GetMe, GETME, getme, getMe are ok, but get_me is not ok).

Required Associated Types

type Output

The return type of a Telegram method.

Note: it should not include Result wrappers (e.g. it should be simply Message, True or something else).

Provided Methods

fn timeout_hint(&self) -> Option<Duration>

If this payload may take long time to execute (e.g. GetUpdates with big timeout), the minimum timeout that should be used.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Payload for AddStickerToSet

const NAME: &'static str = "AddStickerToSet"

type Output = True

impl Payload for AnswerCallbackQuery

const NAME: &'static str = "AnswerCallbackQuery"

type Output = True

impl Payload for AnswerInlineQuery

const NAME: &'static str = "AnswerInlineQuery"

type Output = True

impl Payload for AnswerPreCheckoutQuery

const NAME: &'static str = "AnswerPreCheckoutQuery"

type Output = True

impl Payload for AnswerShippingQuery

const NAME: &'static str = "AnswerShippingQuery"

type Output = True

impl Payload for AnswerWebAppQuery

const NAME: &'static str = "AnswerWebAppQuery"

type Output = SentWebAppMessage

impl Payload for ApproveChatJoinRequest

const NAME: &'static str = "ApproveChatJoinRequest"

type Output = True

impl Payload for BanChatMember

const NAME: &'static str = "BanChatMember"

type Output = True

impl Payload for BanChatSenderChat

const NAME: &'static str = "BanChatSenderChat"

type Output = True

impl Payload for Close

const NAME: &'static str = "Close"

type Output = True

impl Payload for CloseForumTopic

const NAME: &'static str = "CloseForumTopic"

type Output = True

impl Payload for CloseGeneralForumTopic

const NAME: &'static str = "CloseGeneralForumTopic"

type Output = True

impl Payload for CopyMessage

const NAME: &'static str = "CopyMessage"

type Output = MessageId

impl Payload for CopyMessages

const NAME: &'static str = "CopyMessages"

type Output = Vec<MessageId>

impl Payload for CreateChatInviteLink

const NAME: &'static str = "CreateChatInviteLink"

type Output = ChatInviteLink

impl Payload for CreateForumTopic

const NAME: &'static str = "CreateForumTopic"

type Output = ForumTopic

impl Payload for CreateInvoiceLink

const NAME: &'static str = "CreateInvoiceLink"

type Output = String

impl Payload for CreateNewStickerSet

const NAME: &'static str = "CreateNewStickerSet"

type Output = True

impl Payload for DeclineChatJoinRequest

const NAME: &'static str = "DeclineChatJoinRequest"

type Output = True

impl Payload for DeleteChatPhoto

const NAME: &'static str = "DeleteChatPhoto"

type Output = String

impl Payload for DeleteChatStickerSet

const NAME: &'static str = "DeleteChatStickerSet"

type Output = True

impl Payload for DeleteForumTopic

const NAME: &'static str = "DeleteForumTopic"

type Output = True

impl Payload for DeleteMessage

const NAME: &'static str = "DeleteMessage"

type Output = True

impl Payload for DeleteMessages

const NAME: &'static str = "DeleteMessages"

type Output = True

impl Payload for DeleteMyCommands

const NAME: &'static str = "DeleteMyCommands"

type Output = True

impl Payload for DeleteStickerFromSet

const NAME: &'static str = "DeleteStickerFromSet"

type Output = True

impl Payload for DeleteStickerSet

const NAME: &'static str = "DeleteStickerSet"

type Output = True

impl Payload for DeleteWebhook

const NAME: &'static str = "DeleteWebhook"

type Output = True

impl Payload for EditChatInviteLink

const NAME: &'static str = "EditChatInviteLink"

type Output = String

impl Payload for EditForumTopic

const NAME: &'static str = "EditForumTopic"

type Output = True

impl Payload for EditGeneralForumTopic

const NAME: &'static str = "EditGeneralForumTopic"

type Output = True

impl Payload for EditMessageCaption

const NAME: &'static str = "EditMessageCaption"

type Output = Message

impl Payload for EditMessageCaptionInline

const NAME: &'static str = "EditMessageCaptionInline"

type Output = True

impl Payload for EditMessageLiveLocation

const NAME: &'static str = "EditMessageLiveLocation"

type Output = Message

impl Payload for EditMessageLiveLocationInline

const NAME: &'static str = "EditMessageLiveLocationInline"

type Output = True

impl Payload for EditMessageMedia

const NAME: &'static str = "EditMessageMedia"

type Output = Message

impl Payload for EditMessageMediaInline

const NAME: &'static str = "EditMessageMediaInline"

type Output = True

impl Payload for EditMessageReplyMarkup

const NAME: &'static str = "EditMessageReplyMarkup"

type Output = Message

impl Payload for EditMessageReplyMarkupInline

const NAME: &'static str = "EditMessageReplyMarkupInline"

type Output = True

impl Payload for EditMessageText

const NAME: &'static str = "EditMessageText"

type Output = Message

impl Payload for EditMessageTextInline

const NAME: &'static str = "EditMessageTextInline"

type Output = True

impl Payload for ExportChatInviteLink

const NAME: &'static str = "ExportChatInviteLink"

type Output = String

impl Payload for ForwardMessage

const NAME: &'static str = "ForwardMessage"

type Output = Message

impl Payload for ForwardMessages

const NAME: &'static str = "ForwardMessages"

type Output = Vec<MessageId>

impl Payload for GetChat

const NAME: &'static str = "GetChat"

type Output = Chat

impl Payload for GetChatAdministrators

const NAME: &'static str = "GetChatAdministrators"

type Output = Vec<ChatMember>

impl Payload for GetChatMember

const NAME: &'static str = "GetChatMember"

type Output = ChatMember

impl Payload for GetChatMemberCount

const NAME: &'static str = "GetChatMemberCount"

type Output = u32

impl Payload for GetChatMembersCount

const NAME: &'static str = "GetChatMembersCount"

type Output = u32

impl Payload for GetChatMenuButton

const NAME: &'static str = "GetChatMenuButton"

type Output = MenuButton

impl Payload for GetCustomEmojiStickers

const NAME: &'static str = "GetCustomEmojiStickers"

type Output = Vec<Sticker>

impl Payload for GetFile

const NAME: &'static str = "GetFile"

type Output = File

impl Payload for GetForumTopicIconStickers

const NAME: &'static str = "GetForumTopicIconStickers"

type Output = Vec<Sticker>

impl Payload for GetGameHighScores

const NAME: &'static str = "GetGameHighScores"

type Output = True

impl Payload for GetMe

const NAME: &'static str = "GetMe"

type Output = Me

impl Payload for GetMyCommands

const NAME: &'static str = "GetMyCommands"

type Output = Vec<BotCommand>

impl Payload for GetMyDefaultAdministratorRights

const NAME: &'static str = "GetMyDefaultAdministratorRights"

type Output = ChatAdministratorRights

impl Payload for GetMyDescription

const NAME: &'static str = "GetMyDescription"

type Output = BotDescription

impl Payload for GetMyName

const NAME: &'static str = "GetMyName"

type Output = BotName

impl Payload for GetMyShortDescription

const NAME: &'static str = "GetMyShortDescription"

type Output = BotShortDescription

impl Payload for GetStickerSet

const NAME: &'static str = "GetStickerSet"

type Output = StickerSet

impl Payload for GetUpdates

const NAME: &'static str = "GetUpdates"

type Output = Vec<Update>

impl Payload for GetUserChatBoosts

const NAME: &'static str = "GetUserChatBoosts"

type Output = UserChatBoosts

impl Payload for GetUserProfilePhotos

const NAME: &'static str = "GetUserProfilePhotos"

type Output = UserProfilePhotos

impl Payload for GetWebhookInfo

const NAME: &'static str = "GetWebhookInfo"

type Output = WebhookInfo

impl Payload for HideGeneralForumTopic

const NAME: &'static str = "HideGeneralForumTopic"

type Output = True

impl Payload for KickChatMember

const NAME: &'static str = "KickChatMember"

type Output = True

impl Payload for LeaveChat

const NAME: &'static str = "LeaveChat"

type Output = True

impl Payload for LogOut

const NAME: &'static str = "LogOut"

type Output = True

impl Payload for PinChatMessage

const NAME: &'static str = "PinChatMessage"

type Output = True

impl Payload for PromoteChatMember

const NAME: &'static str = "PromoteChatMember"

type Output = True

impl Payload for ReopenForumTopic

const NAME: &'static str = "ReopenForumTopic"

type Output = True

impl Payload for ReopenGeneralForumTopic

const NAME: &'static str = "ReopenGeneralForumTopic"

type Output = True

impl Payload for RestrictChatMember

const NAME: &'static str = "RestrictChatMember"

type Output = True

impl Payload for RevokeChatInviteLink

const NAME: &'static str = "RevokeChatInviteLink"

type Output = String

impl Payload for SendAnimation

const NAME: &'static str = "SendAnimation"

type Output = Message

impl Payload for SendAudio

const NAME: &'static str = "SendAudio"

type Output = Message

impl Payload for SendChatAction

const NAME: &'static str = "SendChatAction"

type Output = True

impl Payload for SendContact

const NAME: &'static str = "SendContact"

type Output = Message

impl Payload for SendDice

const NAME: &'static str = "SendDice"

type Output = Message

impl Payload for SendDocument

const NAME: &'static str = "SendDocument"

type Output = Message

impl Payload for SendGame

const NAME: &'static str = "SendGame"

type Output = Message

impl Payload for SendInvoice

const NAME: &'static str = "SendInvoice"

type Output = Message

impl Payload for SendLocation

const NAME: &'static str = "SendLocation"

type Output = Message

impl Payload for SendMediaGroup

const NAME: &'static str = "SendMediaGroup"

type Output = Vec<Message>

impl Payload for SendMessage

const NAME: &'static str = "SendMessage"

type Output = Message

impl Payload for SendPhoto

const NAME: &'static str = "SendPhoto"

type Output = Message

impl Payload for SendPoll

const NAME: &'static str = "SendPoll"

type Output = Message

impl Payload for SendSticker

const NAME: &'static str = "SendSticker"

type Output = Message

impl Payload for SendVenue

const NAME: &'static str = "SendVenue"

type Output = Message

impl Payload for SendVideo

const NAME: &'static str = "SendVideo"

type Output = Message

impl Payload for SendVideoNote

const NAME: &'static str = "SendVideoNote"

type Output = Message

impl Payload for SendVoice

const NAME: &'static str = "SendVoice"

type Output = Message

impl Payload for SetChatAdministratorCustomTitle

const NAME: &'static str = "SetChatAdministratorCustomTitle"

type Output = True

impl Payload for SetChatDescription

const NAME: &'static str = "SetChatDescription"

type Output = True

impl Payload for SetChatMenuButton

const NAME: &'static str = "SetChatMenuButton"

type Output = True

impl Payload for SetChatPermissions

const NAME: &'static str = "SetChatPermissions"

type Output = True

impl Payload for SetChatPhoto

const NAME: &'static str = "SetChatPhoto"

type Output = True

impl Payload for SetChatStickerSet

const NAME: &'static str = "SetChatStickerSet"

type Output = True

impl Payload for SetChatTitle

const NAME: &'static str = "SetChatTitle"

type Output = True

impl Payload for SetCustomEmojiStickerSetThumbnail

const NAME: &'static str = "SetCustomEmojiStickerSetThumbnail"

type Output = True

impl Payload for SetGameScore

const NAME: &'static str = "SetGameScore"

type Output = Message

impl Payload for SetGameScoreInline

const NAME: &'static str = "SetGameScoreInline"

type Output = True

impl Payload for SetMessageReaction

const NAME: &'static str = "SetMessageReaction"

type Output = True

impl Payload for SetMyCommands

const NAME: &'static str = "SetMyCommands"

type Output = True

impl Payload for SetMyDefaultAdministratorRights

const NAME: &'static str = "SetMyDefaultAdministratorRights"

type Output = True

impl Payload for SetMyDescription

const NAME: &'static str = "SetMyDescription"

type Output = True

impl Payload for SetMyName

const NAME: &'static str = "SetMyName"

type Output = True

impl Payload for SetMyShortDescription

const NAME: &'static str = "SetMyShortDescription"

type Output = True

impl Payload for SetPassportDataErrors

const NAME: &'static str = "SetPassportDataErrors"

type Output = True

impl Payload for SetStickerEmojiList

const NAME: &'static str = "SetStickerEmojiList"

type Output = True

impl Payload for SetStickerKeywords

const NAME: &'static str = "SetStickerKeywords"

type Output = True

impl Payload for SetStickerMaskPosition

const NAME: &'static str = "SetStickerMaskPosition"

type Output = True

impl Payload for SetStickerPositionInSet

const NAME: &'static str = "SetStickerPositionInSet"

type Output = True

impl Payload for SetStickerSetThumbnail

const NAME: &'static str = "SetStickerSetThumbnail"

type Output = True

impl Payload for SetStickerSetTitle

const NAME: &'static str = "SetStickerSetTitle"

type Output = True

impl Payload for SetWebhook

const NAME: &'static str = "SetWebhook"

type Output = True

impl Payload for StopMessageLiveLocation

const NAME: &'static str = "StopMessageLiveLocation"

type Output = Message

impl Payload for StopMessageLiveLocationInline

const NAME: &'static str = "StopMessageLiveLocationInline"

type Output = True

impl Payload for StopPoll

const NAME: &'static str = "StopPoll"

type Output = Poll

impl Payload for UnbanChatMember

const NAME: &'static str = "UnbanChatMember"

type Output = True

impl Payload for UnbanChatSenderChat

const NAME: &'static str = "UnbanChatSenderChat"

type Output = True

impl Payload for UnhideGeneralForumTopic

const NAME: &'static str = "UnhideGeneralForumTopic"

type Output = True

impl Payload for UnpinAllChatMessages

const NAME: &'static str = "UnpinAllChatMessages"

type Output = True

impl Payload for UnpinAllForumTopicMessages

const NAME: &'static str = "UnpinAllForumTopicMessages"

type Output = True

impl Payload for UnpinAllGeneralForumTopicMessages

const NAME: &'static str = "UnpinAllGeneralForumTopicMessages"

type Output = True

impl Payload for UnpinChatMessage

const NAME: &'static str = "UnpinChatMessage"

type Output = True

impl Payload for UploadStickerFile

const NAME: &'static str = "UploadStickerFile"

type Output = FileMeta