Struct Throttle

Source

pub struct Throttle<B> { /* private fields */ }

Available on crate feature throttle only.

Expand description

Automatic request limits respecting mechanism.

Telegram has strict limits, which, if exceeded will sooner or later cause RequestError::RetryAfter(_) errors. These errors can cause users of your bot to never receive responses from the bot or receive them in a wrong order.

This bot wrapper automatically checks for limits, suspending requests until they could be sent without exceeding limits (request order in chats is not changed).

It’s recommended to use this wrapper before other wrappers (i.e.: SomeWrapper<Throttle<Bot>> not Throttle<SomeWrapper<Bot>>) because if done otherwise inner wrappers may cause Throttle to miscalculate limits usage.

§Examples

use teloxide_core::{adaptors::throttle::Limits, requests::RequesterExt, Bot};

let bot = Bot::new("TOKEN")
    .throttle(Limits::default());

/* send many requests here */

§Note about send-by-@channelusername

Telegram have limits on sending messages to the same chat. To check them we store chat_ids of several last requests. However there is no good way to tell if given ChatId::Id(x) corresponds to the same chat as ChatId::ChannelUsername(u).

Our current approach is to just give up and check chat_id_a == chat_id_b. This may give incorrect results.

As such, we encourage not to use ChatId::ChannelUsername(u) with this bot wrapper.

Struct ThrottleCopy item path

§Examples

§Note about send-by-@channelusername

Implementations§

impl<B> Throttle<B>

pub fn new(bot: B, limits: Limits) -> (Self, impl Future<Output = ()>)where B: Requester + Clone, B::Err: AsResponseParameters,

pub fn with_settings( bot: B, settings: Settings, ) -> (Self, impl Future<Output = ()>)where B: Requester + Clone, B::Err: AsResponseParameters,

pub fn new_spawn(bot: B, limits: Limits) -> Selfwhere B: Requester + Clone + Send + Sync + 'static, B::Err: AsResponseParameters, B::GetChat: Send,

pub fn spawn_with_settings(bot: B, settings: Settings) -> Selfwhere B: Requester + Clone + Send + Sync + 'static, B::Err: AsResponseParameters, B::GetChat: Send,

pub fn inner(&self) -> &B

pub fn into_inner(self) -> B

pub async fn limits(&self) -> Limits

pub async fn set_limits(&self, new: Limits)

Trait Implementations§

impl<B: Clone> Clone for Throttle<B>

fn clone(&self) -> Throttle<B> ⓘ

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

impl<B: Debug> Debug for Throttle<B>

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

impl<B: Download> Download for Throttle<B>

type Err<'dst> = <B as Download>::Err<'dst>

type Fut<'dst> = <B as Download>::Fut<'dst>

type StreamErr = <B as Download>::StreamErr

type Stream = <B as Download>::Stream

fn download_file<'dst>( &self, path: &str, destination: &'dst mut (dyn AsyncWrite + Unpin + Send), ) -> Self::Fut<'dst>

fn download_file_stream(&self, path: &str) -> Self::Stream

type Err = <B as Requester>::Err

type SendMessage = ThrottlingRequest<<B as Requester>::SendMessage>

type ForwardMessage = ThrottlingRequest<<B as Requester>::ForwardMessage>

type CopyMessage = ThrottlingRequest<<B as Requester>::CopyMessage>

type SendPhoto = ThrottlingRequest<<B as Requester>::SendPhoto>

type SendAudio = ThrottlingRequest<<B as Requester>::SendAudio>

type SendDocument = ThrottlingRequest<<B as Requester>::SendDocument>

type SendVideo = ThrottlingRequest<<B as Requester>::SendVideo>

type SendAnimation = ThrottlingRequest<<B as Requester>::SendAnimation>

type SendVoice = ThrottlingRequest<<B as Requester>::SendVoice>

type SendVideoNote = ThrottlingRequest<<B as Requester>::SendVideoNote>

type SendMediaGroup = ThrottlingRequest<<B as Requester>::SendMediaGroup>

type SendLocation = ThrottlingRequest<<B as Requester>::SendLocation>

type SendVenue = ThrottlingRequest<<B as Requester>::SendVenue>

type SendContact = ThrottlingRequest<<B as Requester>::SendContact>

type SendPoll = ThrottlingRequest<<B as Requester>::SendPoll>

type SendDice = ThrottlingRequest<<B as Requester>::SendDice>

type SendSticker = ThrottlingRequest<<B as Requester>::SendSticker>

type SendInvoice = ThrottlingRequest<<B as Requester>::SendInvoice>

type GetMe = <B as Requester>::GetMe

type LogOut = <B as Requester>::LogOut

type Close = <B as Requester>::Close

type GetUpdates = <B as Requester>::GetUpdates

type SetWebhook = <B as Requester>::SetWebhook

type DeleteWebhook = <B as Requester>::DeleteWebhook

type GetWebhookInfo = <B as Requester>::GetWebhookInfo

type ForwardMessages = <B as Requester>::ForwardMessages

type CopyMessages = <B as Requester>::CopyMessages

type EditMessageLiveLocation = <B as Requester>::EditMessageLiveLocation

type EditMessageLiveLocationInline = <B as Requester>::EditMessageLiveLocationInline

type StopMessageLiveLocation = <B as Requester>::StopMessageLiveLocation

type StopMessageLiveLocationInline = <B as Requester>::StopMessageLiveLocationInline

type SendChatAction = <B as Requester>::SendChatAction

type SetMessageReaction = <B as Requester>::SetMessageReaction

type GetUserProfilePhotos = <B as Requester>::GetUserProfilePhotos

type GetFile = <B as Requester>::GetFile

type KickChatMember = <B as Requester>::KickChatMember

type BanChatMember = <B as Requester>::BanChatMember

type UnbanChatMember = <B as Requester>::UnbanChatMember

type RestrictChatMember = <B as Requester>::RestrictChatMember

type PromoteChatMember = <B as Requester>::PromoteChatMember

type SetChatAdministratorCustomTitle = <B as Requester>::SetChatAdministratorCustomTitle

type BanChatSenderChat = <B as Requester>::BanChatSenderChat

type UnbanChatSenderChat = <B as Requester>::UnbanChatSenderChat

type SetChatPermissions = <B as Requester>::SetChatPermissions

type ExportChatInviteLink = <B as Requester>::ExportChatInviteLink

type CreateChatInviteLink = <B as Requester>::CreateChatInviteLink

type EditChatInviteLink = <B as Requester>::EditChatInviteLink

type RevokeChatInviteLink = <B as Requester>::RevokeChatInviteLink

type SetChatPhoto = <B as Requester>::SetChatPhoto

type DeleteChatPhoto = <B as Requester>::DeleteChatPhoto

type SetChatTitle = <B as Requester>::SetChatTitle

type SetChatDescription = <B as Requester>::SetChatDescription

type PinChatMessage = <B as Requester>::PinChatMessage

Struct Throttle

pub fn new(bot: B, limits: Limits) -> (Self, impl Future<Output = ()>)
where B: Requester + Clone, B::Err: AsResponseParameters,

pub fn with_settings( bot: B, settings: Settings, ) -> (Self, impl Future<Output = ()>)
where B: Requester + Clone, B::Err: AsResponseParameters,

pub fn new_spawn(bot: B, limits: Limits) -> Self
where B: Requester + Clone + Send + Sync + 'static, B::Err: AsResponseParameters, B::GetChat: Send,

pub fn spawn_with_settings(bot: B, settings: Settings) -> Self
where B: Requester + Clone + Send + Sync + 'static, B::Err: AsResponseParameters, B::GetChat: Send,