async-speed-limit

Asynchronously speed-limiting multiple byte streams (AsyncRead and AsyncWrite).

Usage

use async_speed_limit::Limiter;
use futures_util::{
    future::try_join,
    io::{self, AsyncRead, AsyncWrite},
};
use std::{marker::Unpin, pin::Pin};

#[cfg(feature = "standard-clock")]
async fn copy_both_slowly(
    r1: impl AsyncRead,
    w1: &mut (impl AsyncWrite + Unpin),
    r2: impl AsyncRead,
    w2: &mut (impl AsyncWrite + Unpin),
) -> io::Result<()> {
    // create a speed limiter of 1.0 KiB/s.
    let limiter = <Limiter>::new(1024.0);

    // limit both readers by the same queue
    // (so 1.0 KiB/s is the combined maximum speed)
    let r1 = limiter.clone().limit(r1);
    let r2 = limiter.limit(r2);

    // do the copy.
    try_join(io::copy(r1, w1), io::copy(r2, w2)).await?;
    Ok(())
}

Algorithm

async-speed-limit imposes the maximum speed limit using the token bucket algorithm with a single queue. Transmission is throttled by adding a delay proportional to the consumed tokens after it is sent. Because of this, the traffic flow will have high burstiness around when the token bucket is full.

The time needed to refill the bucket from empty to full is called the refill period. Reducing the refill period also reduces burstiness, but there would be more sleeps. The default value (0.1 s) should be good enough for most situations.

Tokio 0.1

async-speed-limit is designed for "Futures 0.3". This package does not directly support Tokio 0.1, but you can use futures-util's compat module to bridge the types.

Cargo features

Name	Dependency	Effect
standard-clock (default)	futures-timer	Enables the clock::StandardClock struct.
fused-future (default)	futures-core	Implements FusedFuture on limiter::Consume.
futures-io (default)	futures-io	Implements AsyncRead and AsyncWrite on limiter::Resource.
read-initializer	-	Deprecated and does nothing. This feature has been removed since futures-io 0.3.19.

License

async-speed-limit is dual-licensed under

• Apache 2.0 license (LICENSE-Apache or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)