Skip to main content

RateLimiterConfig

Struct RateLimiterConfig 

Source
pub struct RateLimiterConfig {
    pub default: BucketLimit,
    pub overrides: HashMap<RateLimitKey, BucketLimit>,
}
Expand description

Configuration for the optional per-endpoint rate limiter.

Pass this via Config::rate_limiter to have the client pre-flight-check a local bucket before every request and reject calls that would obviously hit the exchange’s limits.

Bybit tracks a separate limit per endpoint (and, for order endpoints, per category) rather than one account-wide limit, and batch order endpoints consume one unit of quota per order in the batch, not one per request (https://bybit-exchange.github.io/docs/v5/rate-limit). This limiter mirrors that: each RateLimitKey gets its own independent token bucket and its own server-feedback state, and every call site reports how many units it actually costs.

Two checks are combined per bucket:

  1. Token bucket — tokens refill at the bucket’s requests_per_second. An initial burst of burst tokens is available. When the bucket doesn’t have enough tokens for the request’s cost, the request is rejected immediately with Error::RateLimited.

  2. Server feedback — after every response, Bybit’s X-Bapi-Limit-Status / X-Bapi-Limit-Reset-Timestamp headers are recorded against that response’s bucket. If the server-reported remaining count reaches zero, the next request against that same bucket is rejected with Error::RateLimited until the reset window passes, regardless of local token state.

Bybit’s limits vary by account VIP/Pro tier and change over time, so this crate does not hardcode them: populate overrides yourself from https://bybit-exchange.github.io/docs/v5/rate-limit, or start from RateLimiterConfig::bybit_base_tier_defaults and adjust it for your tier.

Fields§

§default: BucketLimit

Limit applied to any RateLimitKey not present in overrides.

§overrides: HashMap<RateLimitKey, BucketLimit>

Per-endpoint (optionally per-category) overrides.

Implementations§

Source§

impl RateLimiterConfig

Source

pub fn uniform(requests_per_second: f64, burst: u32) -> Self

A single limit shared by every endpoint, with no per-endpoint overrides.

Equivalent to this crate’s previous, endpoint-unaware rate limiter. Prefer RateLimiterConfig::bybit_base_tier_defaults for a more accurate starting point.

Source

pub fn bybit_base_tier_defaults() -> Self

Starting-point overrides for the base (non-VIP) tier’s most commonly used endpoints, taken from https://bybit-exchange.github.io/docs/v5/rate-limit. Not exhaustive — it only covers the Trade endpoints (where the limit varies sharply by category and, for batch endpoints, is easy to blow through without per-order weighting) plus a couple of high-traffic Account ones. Add your own overrides for anything else, and adjust these if your account has a VIP/Pro tier.

default is set to a conservative 5 req/s, 5 burst for everything not listed here.

Source

pub fn with_override(self, key: RateLimitKey, limit: BucketLimit) -> Self

Set the limit of one bucket.

Trait Implementations§

Source§

impl Clone for RateLimiterConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimiterConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more