Trait teloxide_core::requests::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 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).

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

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.

Object Safety

This trait is not object safe.

Implementors

impl Payload for AddStickerToSet

type Output = True

const NAME: &'static str = "AddStickerToSet"

impl Payload for AnswerCallbackQuery

type Output = True

const NAME: &'static str = "AnswerCallbackQuery"

impl Payload for AnswerInlineQuery

type Output = True

const NAME: &'static str = "AnswerInlineQuery"

impl Payload for AnswerPreCheckoutQuery

type Output = True

const NAME: &'static str = "AnswerPreCheckoutQuery"

impl Payload for AnswerShippingQuery

type Output = True

const NAME: &'static str = "AnswerShippingQuery"

impl Payload for AnswerWebAppQuery

type Output = SentWebAppMessage

const NAME: &'static str = "AnswerWebAppQuery"

impl Payload for ApproveChatJoinRequest

type Output = True

const NAME: &'static str = "ApproveChatJoinRequest"

impl Payload for BanChatMember

type Output = True

const NAME: &'static str = "BanChatMember"

impl Payload for BanChatSenderChat

type Output = True

const NAME: &'static str = "BanChatSenderChat"

impl Payload for Close

type Output = True

const NAME: &'static str = "Close"

impl Payload for CloseForumTopic

type Output = True

const NAME: &'static str = "CloseForumTopic"

impl Payload for CloseGeneralForumTopic

type Output = True

const NAME: &'static str = "CloseGeneralForumTopic"

impl Payload for CopyMessage

type Output = MessageId

const NAME: &'static str = "CopyMessage"

impl Payload for CopyMessages

type Output = Vec<MessageId>

const NAME: &'static str = "CopyMessages"

impl Payload for CreateChatInviteLink

type Output = ChatInviteLink

const NAME: &'static str = "CreateChatInviteLink"

impl Payload for CreateForumTopic

type Output = ForumTopic

const NAME: &'static str = "CreateForumTopic"

impl Payload for CreateInvoiceLink

type Output = String

const NAME: &'static str = "CreateInvoiceLink"

impl Payload for CreateNewStickerSet

type Output = True

const NAME: &'static str = "CreateNewStickerSet"

impl Payload for DeclineChatJoinRequest

type Output = True

const NAME: &'static str = "DeclineChatJoinRequest"

impl Payload for DeleteChatPhoto

type Output = String

const NAME: &'static str = "DeleteChatPhoto"

impl Payload for DeleteChatStickerSet

type Output = True

const NAME: &'static str = "DeleteChatStickerSet"

impl Payload for DeleteForumTopic

type Output = True

const NAME: &'static str = "DeleteForumTopic"

impl Payload for DeleteMessage

type Output = True

const NAME: &'static str = "DeleteMessage"

impl Payload for DeleteMessages

type Output = True

const NAME: &'static str = "DeleteMessages"

impl Payload for DeleteMyCommands

type Output = True

const NAME: &'static str = "DeleteMyCommands"

impl Payload for DeleteStickerFromSet

type Output = True

const NAME: &'static str = "DeleteStickerFromSet"

impl Payload for DeleteStickerSet

type Output = True

const NAME: &'static str = "DeleteStickerSet"

impl Payload for DeleteWebhook

type Output = True

const NAME: &'static str = "DeleteWebhook"

impl Payload for EditChatInviteLink

type Output = String

const NAME: &'static str = "EditChatInviteLink"

impl Payload for EditForumTopic

type Output = True

const NAME: &'static str = "EditForumTopic"

impl Payload for EditGeneralForumTopic

type Output = True

const NAME: &'static str = "EditGeneralForumTopic"

impl Payload for EditMessageCaption

type Output = Message

const NAME: &'static str = "EditMessageCaption"

impl Payload for EditMessageCaptionInline

type Output = True

const NAME: &'static str = "EditMessageCaptionInline"

impl Payload for EditMessageLiveLocation

type Output = Message

const NAME: &'static str = "EditMessageLiveLocation"

impl Payload for EditMessageLiveLocationInline

type Output = True

const NAME: &'static str = "EditMessageLiveLocationInline"

impl Payload for EditMessageMedia

type Output = Message

const NAME: &'static str = "EditMessageMedia"

impl Payload for EditMessageMediaInline

type Output = True

const NAME: &'static str = "EditMessageMediaInline"

impl Payload for EditMessageReplyMarkup

type Output = Message

const NAME: &'static str = "EditMessageReplyMarkup"

impl Payload for EditMessageReplyMarkupInline

type Output = True

const NAME: &'static str = "EditMessageReplyMarkupInline"

impl Payload for EditMessageText

type Output = Message

const NAME: &'static str = "EditMessageText"

impl Payload for EditMessageTextInline

type Output = True

const NAME: &'static str = "EditMessageTextInline"

impl Payload for ExportChatInviteLink

type Output = String

const NAME: &'static str = "ExportChatInviteLink"

impl Payload for ForwardMessage

type Output = Message

const NAME: &'static str = "ForwardMessage"

impl Payload for ForwardMessages

type Output = Vec<MessageId>

const NAME: &'static str = "ForwardMessages"

impl Payload for GetChat

type Output = Chat

const NAME: &'static str = "GetChat"

impl Payload for GetChatAdministrators

type Output = Vec<ChatMember>

const NAME: &'static str = "GetChatAdministrators"

impl Payload for GetChatMember

type Output = ChatMember

const NAME: &'static str = "GetChatMember"

impl Payload for GetChatMemberCount

type Output = u32

const NAME: &'static str = "GetChatMemberCount"

impl Payload for GetChatMembersCount

type Output = u32

const NAME: &'static str = "GetChatMembersCount"

impl Payload for GetChatMenuButton

type Output = MenuButton

const NAME: &'static str = "GetChatMenuButton"

impl Payload for GetCustomEmojiStickers

type Output = Vec<Sticker>

const NAME: &'static str = "GetCustomEmojiStickers"

impl Payload for GetFile

type Output = File

const NAME: &'static str = "GetFile"

impl Payload for GetForumTopicIconStickers

type Output = Vec<Sticker>

const NAME: &'static str = "GetForumTopicIconStickers"

impl Payload for GetGameHighScores

type Output = True

const NAME: &'static str = "GetGameHighScores"

impl Payload for GetMe

type Output = Me

const NAME: &'static str = "GetMe"

impl Payload for GetMyCommands

type Output = Vec<BotCommand>

const NAME: &'static str = "GetMyCommands"

impl Payload for GetMyDefaultAdministratorRights

type Output = ChatAdministratorRights

const NAME: &'static str = "GetMyDefaultAdministratorRights"

impl Payload for GetMyDescription

type Output = BotDescription

const NAME: &'static str = "GetMyDescription"

impl Payload for GetMyName

type Output = BotName

const NAME: &'static str = "GetMyName"

impl Payload for GetMyShortDescription

type Output = BotShortDescription

const NAME: &'static str = "GetMyShortDescription"

impl Payload for GetStickerSet

type Output = StickerSet

const NAME: &'static str = "GetStickerSet"

impl Payload for GetUpdates

type Output = Vec<Update>

const NAME: &'static str = "GetUpdates"

impl Payload for GetUserChatBoosts

type Output = UserChatBoosts

const NAME: &'static str = "GetUserChatBoosts"

impl Payload for GetUserProfilePhotos

type Output = UserProfilePhotos

const NAME: &'static str = "GetUserProfilePhotos"

impl Payload for GetWebhookInfo

type Output = WebhookInfo

const NAME: &'static str = "GetWebhookInfo"

impl Payload for HideGeneralForumTopic

type Output = True

const NAME: &'static str = "HideGeneralForumTopic"

impl Payload for KickChatMember

type Output = True

const NAME: &'static str = "KickChatMember"

impl Payload for LeaveChat

type Output = True

const NAME: &'static str = "LeaveChat"

impl Payload for LogOut

type Output = True

const NAME: &'static str = "LogOut"

impl Payload for PinChatMessage

type Output = True

const NAME: &'static str = "PinChatMessage"

impl Payload for PromoteChatMember

type Output = True

const NAME: &'static str = "PromoteChatMember"

impl Payload for ReopenForumTopic

type Output = True

const NAME: &'static str = "ReopenForumTopic"

impl Payload for ReopenGeneralForumTopic

type Output = True

const NAME: &'static str = "ReopenGeneralForumTopic"

impl Payload for RestrictChatMember

type Output = True

const NAME: &'static str = "RestrictChatMember"

impl Payload for RevokeChatInviteLink

type Output = String

const NAME: &'static str = "RevokeChatInviteLink"

impl Payload for SendAnimation

type Output = Message

const NAME: &'static str = "SendAnimation"

impl Payload for SendAudio

type Output = Message

const NAME: &'static str = "SendAudio"

impl Payload for SendChatAction

type Output = True

const NAME: &'static str = "SendChatAction"

impl Payload for SendContact

type Output = Message

const NAME: &'static str = "SendContact"

impl Payload for SendDice

type Output = Message

const NAME: &'static str = "SendDice"

impl Payload for SendDocument

type Output = Message

const NAME: &'static str = "SendDocument"

impl Payload for SendGame

type Output = Message

const NAME: &'static str = "SendGame"

impl Payload for SendInvoice

type Output = Message

const NAME: &'static str = "SendInvoice"

impl Payload for SendLocation

type Output = Message

const NAME: &'static str = "SendLocation"

impl Payload for SendMediaGroup

type Output = Vec<Message>

const NAME: &'static str = "SendMediaGroup"

impl Payload for SendMessage

type Output = Message

const NAME: &'static str = "SendMessage"

impl Payload for SendPhoto

type Output = Message

const NAME: &'static str = "SendPhoto"

impl Payload for SendPoll

type Output = Message

const NAME: &'static str = "SendPoll"

impl Payload for SendSticker

type Output = Message

const NAME: &'static str = "SendSticker"

impl Payload for SendVenue

type Output = Message

const NAME: &'static str = "SendVenue"

impl Payload for SendVideo

type Output = Message

const NAME: &'static str = "SendVideo"

impl Payload for SendVideoNote

type Output = Message

const NAME: &'static str = "SendVideoNote"

impl Payload for SendVoice

type Output = Message

const NAME: &'static str = "SendVoice"

impl Payload for SetChatAdministratorCustomTitle

type Output = True

const NAME: &'static str = "SetChatAdministratorCustomTitle"

impl Payload for SetChatDescription

type Output = True

const NAME: &'static str = "SetChatDescription"

impl Payload for SetChatMenuButton

type Output = True

const NAME: &'static str = "SetChatMenuButton"

impl Payload for SetChatPermissions

type Output = True

const NAME: &'static str = "SetChatPermissions"

impl Payload for SetChatPhoto

type Output = True

const NAME: &'static str = "SetChatPhoto"

impl Payload for SetChatStickerSet

type Output = True

const NAME: &'static str = "SetChatStickerSet"

impl Payload for SetChatTitle

type Output = True

const NAME: &'static str = "SetChatTitle"

impl Payload for SetCustomEmojiStickerSetThumbnail

type Output = True

const NAME: &'static str = "SetCustomEmojiStickerSetThumbnail"

impl Payload for SetGameScore

type Output = Message

const NAME: &'static str = "SetGameScore"

impl Payload for SetGameScoreInline

type Output = True

const NAME: &'static str = "SetGameScoreInline"

impl Payload for SetMessageReaction

type Output = True

const NAME: &'static str = "SetMessageReaction"

impl Payload for SetMyCommands

type Output = True

const NAME: &'static str = "SetMyCommands"

impl Payload for SetMyDefaultAdministratorRights

type Output = True

const NAME: &'static str = "SetMyDefaultAdministratorRights"

impl Payload for SetMyDescription

type Output = True

const NAME: &'static str = "SetMyDescription"

impl Payload for SetMyName

type Output = True

const NAME: &'static str = "SetMyName"

impl Payload for SetMyShortDescription

type Output = True

const NAME: &'static str = "SetMyShortDescription"

impl Payload for SetPassportDataErrors

type Output = True

const NAME: &'static str = "SetPassportDataErrors"

impl Payload for SetStickerEmojiList

type Output = True

const NAME: &'static str = "SetStickerEmojiList"

impl Payload for SetStickerKeywords

type Output = True

const NAME: &'static str = "SetStickerKeywords"

impl Payload for SetStickerMaskPosition

type Output = True

const NAME: &'static str = "SetStickerMaskPosition"

impl Payload for SetStickerPositionInSet

type Output = True

const NAME: &'static str = "SetStickerPositionInSet"

impl Payload for SetStickerSetThumbnail

type Output = True

const NAME: &'static str = "SetStickerSetThumbnail"

impl Payload for SetStickerSetTitle

type Output = True

const NAME: &'static str = "SetStickerSetTitle"

impl Payload for SetWebhook

type Output = True

const NAME: &'static str = "SetWebhook"

impl Payload for StopMessageLiveLocation

type Output = Message

const NAME: &'static str = "StopMessageLiveLocation"

impl Payload for StopMessageLiveLocationInline

type Output = True

const NAME: &'static str = "StopMessageLiveLocationInline"

impl Payload for StopPoll

type Output = Poll

const NAME: &'static str = "StopPoll"

impl Payload for UnbanChatMember

type Output = True

const NAME: &'static str = "UnbanChatMember"

impl Payload for UnbanChatSenderChat

type Output = True

const NAME: &'static str = "UnbanChatSenderChat"

impl Payload for UnhideGeneralForumTopic

type Output = True

const NAME: &'static str = "UnhideGeneralForumTopic"

impl Payload for UnpinAllChatMessages

type Output = True

const NAME: &'static str = "UnpinAllChatMessages"

impl Payload for UnpinAllForumTopicMessages

type Output = True

const NAME: &'static str = "UnpinAllForumTopicMessages"

impl Payload for UnpinAllGeneralForumTopicMessages

type Output = True

const NAME: &'static str = "UnpinAllGeneralForumTopicMessages"

impl Payload for UnpinChatMessage

type Output = True

const NAME: &'static str = "UnpinChatMessage"

impl Payload for UploadStickerFile

type Output = FileMeta

const NAME: &'static str = "UploadStickerFile"