Enum ThrottleMode 

#[non_exhaustive]
pub enum ThrottleMode {
    PerConn {
        rate: Rate,
        burst: u64,
    },
    Shared(RateLimiter),
}

Available on crate feature net only.

How one direction of a ThrottledIo is budgeted.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PerConn

Each connection gets its own token bucket.

Fields

rate: Rate

the byte rate each connection is allowed

burst: u64

burst capacity in bytes (maximum spendable at once)

Shared(RateLimiter)

An aggregate cap: every connection holding a clone of the RateLimiter handle spends from the same budget.

Implementations

impl ThrottleMode

pub const fn per_conn(rate: Rate) -> ThrottleMode

Per-connection throttling at the given byte Rate, with a burst capacity of one period worth of bytes.

pub const fn per_conn_with_burst(rate: Rate, burst: u64) -> ThrottleMode

Per-connection throttling at the given byte Rate and burst capacity.

Panics

A zero burst panics when the throttled IO is constructed.

pub const fn shared(limiter: RateLimiter) -> ThrottleMode

Shared (aggregate) throttling: all IOs throttled with a clone of the same RateLimiter spend from one budget.

Trait Implementations

impl Clone for ThrottleMode

fn clone(&self) -> ThrottleMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThrottleMode

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

Formats the value using the given formatter.