Enum RateLimitState 

pub enum RateLimitState {
    Ready,
    RateLimited {
        since: u64,
        until_estimate: u64,
        kind: RateLimitType,
    },
}

Current rate-limit state of a client.

Unlike ClientEvent subscriptions (which report transitions), this is a snapshot that can be queried synchronously via SharedEventBroadcaster::rate_limit_state or awaited via the watch channel from SharedEventBroadcaster::watch_rate_limit_state. It is derived automatically from the events flowing through the broadcaster, so every detection and retry path keeps it up to date.

Variants

Ready

No rate limiting currently in effect.

RateLimited

The client is rate limited and expected to be parked until until_estimate.

Fields

since: u64

When the current rate-limit episode began (seconds since Unix epoch).

until_estimate: u64

Best-estimate time at which operation will resume (seconds since Unix epoch). Updated as retries re-detect the limit and extend the backoff.

kind: RateLimitType

How the rate limit was detected.

Implementations

impl RateLimitState

pub fn is_rate_limited_at(&self, now_unix: u64) -> bool

Whether the state indicates active rate limiting at now_unix (seconds since epoch).

Returns false once now_unix has passed until_estimate, even if no event has transitioned the state back to RateLimitState::Ready yet.

pub fn remaining_at(&self, now_unix: u64) -> Option<Duration>

Time remaining until the estimated resume point, if currently rate limited.

Trait Implementations

impl Clone for RateLimitState

fn clone(&self) -> RateLimitState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitState

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

Formats the value using the given formatter.

impl Default for RateLimitState

fn default() -> RateLimitState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimitState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RateLimitState

impl PartialEq for RateLimitState

fn eq(&self, other: &RateLimitState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RateLimitState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RateLimitState