Struct ThrottleLayer 

pub struct ThrottleLayer { /* private fields */ }

Available on crate feature net only.

A Layer that wraps a Service’s input IO Stream with a byte-rate throttle. See ThrottledIo.

Directions are relative to the wrapped connection: read throttles ingress from the peer (back-pressuring it through transport flow control), write paces egress toward it.

Implementations

impl ThrottleLayer

pub fn symmetric(mode: ThrottleMode) -> ThrottleLayer

Create a new ThrottleLayer throttling both directions with the given ThrottleMode.

ThrottleMode::PerConn gives each direction its own (independent) bucket; ThrottleMode::Shared spends both directions from the same aggregate budget.

pub fn read_only(mode: ThrottleMode) -> ThrottleLayer

Create a new ThrottleLayer throttling only the read (ingress) direction.

pub fn write_only(mode: ThrottleMode) -> ThrottleLayer

Create a new ThrottleLayer throttling only the write (egress) direction.

pub fn new( read: Option<ThrottleMode>, write: Option<ThrottleMode>, ) -> ThrottleLayer

Create a new ThrottleLayer with per-direction modes.

pub fn maybe_with_quantum(self, quantum: Option<u64>) -> ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

pub fn maybe_set_quantum(&mut self, quantum: Option<u64>) -> &mut ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

pub fn with_quantum(self, quantum: u64) -> ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

pub fn set_quantum(&mut self, quantum: u64) -> &mut ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

pub fn without_quantum(self) -> ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

pub fn unset_quantum(&mut self) -> &mut ThrottleLayer

Override the grant quantum in bytes: the budget reserved per IO operation (clamped to the burst capacity; defaults to a tenth of a period worth of bytes, at most 16 KiB).

Trait Implementations

impl Clone for ThrottleLayer

fn clone(&self) -> ThrottleLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThrottleLayer

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

Formats the value using the given formatter.

impl Default for ThrottleLayer

fn default() -> ThrottleLayer

Returns the “default value” for a type.

impl<S> Layer<S> for ThrottleLayer

type Service = ThrottleService<S>

The service produced by the layer.

fn layer(&self, inner: S) -> <ThrottleLayer as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> Self::Service

Same as layer but consuming self after the service was created.