Struct teloxide::adaptors::throttle::Settings

#[non_exhaustive]
pub struct Settings {
    pub limits: Limits,
    pub on_queue_full: Box<dyn FnMut(usize) -> Pin<Box<dyn Future<Output = ()> + Send + 'static, Global>> + Send + 'static, Global>,
    pub retry: bool,
    pub check_slow_mode: bool,
}

Available on crate feature throttle only.

Settings used by Throttle adaptor.

Examples

use teloxide_core::adaptors::throttle;

let settings = throttle::Settings::default()
    .on_queue_full(|pending| async move { /* do something when internal queue is full */ });

// use settings in `Throttle::with_settings` or other constructors

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

limits: Limits

on_queue_full: Box<dyn FnMut(usize) -> Pin<Box<dyn Future<Output = ()> + Send + 'static, Global>> + Send + 'static, Global>

retry: bool

check_slow_mode: bool

Implementations

impl Settings

pub fn limits(self, val: Limits) -> Settings

pub fn on_queue_full<F, Fut>(self, val: F) -> Settingswhere
    F: FnMut(usize) -> Fut + Send + 'static,
    Fut: Future<Output = ()> + Send + 'static,

pub fn no_retry(self) -> Settings

pub fn check_slow_mode(self) -> Settings

Trait Implementations

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.