Enum Throttle 

pub enum Throttle<C = RealClock> {
    Stable(Stable<C>),
    AllOut,
}

The throttle mechanism

Variants

Stable(Stable<C>)

Load that comes from this variant is stable with respect to the clock

AllOut

Load that comes from this variant is as fast as possible with respect to the clock

Implementations

impl Throttle<RealClock>

pub fn new_with_config(config: Config, maximum_capacity: NonZeroU32) -> Self

Create a new instance of Throttle with a real-time clock

impl<C> Throttle<C>

where C: Clock + Sync + Send,

pub async fn wait(&mut self) -> Result<(), Error>

Wait for a single unit of capacity to be available, equivalent to wait_for of 1.

Errors

See documentation in Error

pub async fn wait_for(&mut self, request: NonZeroU32) -> Result<(), Error>

Wait for request capacity to be available in the throttle

Errors

See documentation in Error

Trait Implementations

impl<C: Debug> Debug for Throttle<C>

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

Formats the value using the given formatter.