Struct opendal::layers::ThrottleLayer

pub struct ThrottleLayer { /* private fields */ }

Available on crate feature layers-throttle only.

Add a bandwidth rate limiter to the underlying services.

Throttle

There are several algorithms when it come to rate limiting techniques. This throttle layer uses Generic Cell Rate Algorithm (GCRA) provided by Governor. By setting the bandwidth and burst, we can control the byte flow rate of underlying services.

Note

When setting the ThrottleLayer, always consider the largest possible operation size as the burst size, as the burst size should be larger than any possible byte length to allow it to pass through.

Read more about Quota

Examples

This example limits bandwidth to 10 KiB/s and burst size to 10 MiB.

let _ = Operator::new(services::Memory::default())
    .expect("must init")
    .layer(ThrottleLayer::new(10 * 1024, 10000 * 1024))
    .finish();
Ok(())

Implementations

impl ThrottleLayer

pub fn new(bandwidth: u32, burst: u32) -> Self

Create a new ThrottleLayer with given bandwidth and burst.

• bandwidth: the maximum number of bytes allowed to pass through per second.
• burst: the maximum number of bytes allowed to pass through at once.

Trait Implementations

impl Clone for ThrottleLayer

fn clone(&self) -> ThrottleLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Access> Layer<A> for ThrottleLayer

type LayeredAccess = ThrottleAccessor<A>

The layered accessor that returned by this layer.

fn layer(&self, accessor: A) -> Self::LayeredAccess

Intercept the operations on the underlying storage.