Struct AdaptiveLimiter 

pub struct AdaptiveLimiter<S, C = SystemClock>
where
    C: Clock,
{ /* private fields */ }

Available on crate feature adaptive only.

A concurrency limiter whose in-flight limit adapts to observed outcomes.

Build one with AdaptiveLimiter::builder. Behind the adaptive feature.

Examples

use throttle_net::{Aimd, AdaptiveLimiter};

let limiter = AdaptiveLimiter::builder()
    .floor(2)
    .ceiling(50)
    .initial(10)
    .build(Aimd::default());

if let Some(permit) = limiter.try_acquire() {
    // ... call the downstream, then report how it went ...
    let ok = true;
    if ok { permit.success() } else { permit.failure() }
}

Implementations

impl AdaptiveLimiter<Infallible>

pub fn builder() -> AdaptiveLimiterBuilder

Starts building an adaptive limiter.

impl<S, C> AdaptiveLimiter<S, C>

where S: AdaptiveStrategy, C: Clock + Clone,

pub fn with_clock<C2>(self, clock: C2) -> AdaptiveLimiter<S, C2>

where C2: Clock + Clone,

Replaces the time source (used to measure round-trip time), for deterministic tests. Resets the limiter.

pub fn current_limit(&self) -> u32

The current concurrency limit.

pub fn in_flight(&self) -> u32

The number of requests currently in flight.

pub fn ceiling(&self) -> u32

The hard ceiling the adapting limit can never exceed.

pub fn try_acquire(&self) -> Option<AdaptivePermit<'_, S, C>>

Attempts to admit a request without waiting, returning a AdaptivePermit when a slot is free.

impl<S, C> AdaptiveLimiter<S, C>

where S: AdaptiveStrategy, C: Clock + Clone,

pub async fn acquire(&self) -> AdaptivePermit<'_, S, C>

Available on crate feature runtime only.

Admits a request, waiting until a slot is free.

Unlike the rate limiters, this waits on a slot being released (or the limit growing), not on a timer. Returns a AdaptivePermit to settle with the request’s outcome.