Trait Payload

Source

pub trait Payload {
    type Output;

    const NAME: &'static str;

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

Expand description

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§

Source

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§

Source

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§

Source

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

Implementors§

Source §

Trait Payload Copy item path

Required Associated Constants§

const NAME: &'static str

Required Associated Types§

type Output

Provided Methods§

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

Dyn Compatibility§

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 AnswerChatJoinRequestQuery

const NAME: &'static str = "AnswerChatJoinRequestQuery"

type Output = True

impl Payload for AnswerGuestQuery

const NAME: &'static str = "AnswerGuestQuery"

type Output = SentGuestMessage

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 ApproveSuggestedPost

const NAME: &'static str = "ApproveSuggestedPost"

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 ConvertGiftToStars

const NAME: &'static str = "ConvertGiftToStars"

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 CreateChatSubscriptionInviteLink

const NAME: &'static str = "CreateChatSubscriptionInviteLink"

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"

Trait Payload