Struct stream_rate_limiter::RateLimitOptions

pub struct RateLimitOptions<'a> { /* private fields */ }

Options to be used with rate_limit stream extension method

Implementations

impl<'a> RateLimitOptions<'a>

pub fn empty() -> Self

By default stream is not changed at all

pub fn with_interval(self, interval: Duration) -> Self

Set targeted interval between items

pub fn with_interval_sec(self, interval: f64) -> Self

Set targeted interval between items (in seconds)

pub fn with_min_interval(self, min_interval: Duration) -> Self

Set minimum interval between items

pub fn with_min_interval_sec(self, min_interval: f64) -> Self

Set minimum interval between items

pub fn with_allowed_slippage_sec(self, allowed_slippage_sec: f64) -> Self

Set slippage - default slippage if not set (10 times interval + 0.02 sec)
if stream is currently delayed more than this then on_stream_delayed is called

pub fn on_stream_delayed( self, on_stream_delayed: impl FnMut(StreamDelayedInfo) -> StreamBehavior + 'a + Send ) -> Self

Set callback called when stream is delayed more than allowed_slippage_sec
return StreamBehavior::Delay to add permanent delay to stream
return StreamBehavior::Stop to stop stream (terminate without error)
return StreamBehavior::Continue to continue stream (trying catching up)
First argument is current delay, second is permanent delay already in the stream