Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

An async-ready rate limiter.

Call acquire().await before each operation. If the system is ahead of the target rate, it returns immediately. If behind, it awaits until a permit is available. The blocked time is the wait_time that surfaces coordinated omission.

Implementations

impl RateLimiter

pub fn start(spec: RateSpec) -> Self

Create and start a rate limiter from a spec.

pub async fn acquire(&self) -> i64

Acquire one operation permit. Blocks (async) if rate-limited.

Returns the current backlog in ticks (waiting pool value).

Reads ticks_per_op atomically, so a concurrent Self::reconfigure takes effect on the next call.

pub fn wait_time_nanos(&self) -> u64

Current wait time in nanoseconds (backlog converted to nanos).

pub fn total_blocks(&self) -> u64

Total number of acquire calls.

pub fn rate(&self) -> f64

Current ops/sec target.

pub fn spec(&self) -> RateSpec

Current full spec snapshot.

pub fn reconfigure(&self, spec: RateSpec) -> Result<(), String>

Live reconfigure. Atomically swaps the target rate / burst ratio / unit without stopping the refill task. The next Self::acquire call reads the new ticks_per_op; the next refill cycle reads the new burst config.

In-flight backlog (waiting_pool) and already-issued active-pool permits are preserved. If the new rate is much higher than the old one the active pool will fill up over the next few refill ticks; if much lower, already-granted permits still drain before pressure builds.

Validation of the new spec is the caller’s responsibility — a negative or zero ops_per_sec will panic in ticks_per_op. Callers that wire this up through a Control<RateSpec> should install a validator on the control to reject bad values before this method is called.

pub async fn stop(self)

Stop the rate limiter and its refill task.

Trait Implementations

impl Drop for RateLimiter

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.