Struct ThrottleConfig 

pub struct ThrottleConfig { /* private fields */ }

Available on crate feature net only.

How ThrottleLayer and OutgoingThrottleLayer throttle a connection: a ThrottleMode per direction and the grant quantum.

Implementations

impl ThrottleConfig

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

Create a ThrottleConfig with per-direction modes.

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

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 ThrottleConfig

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) -> ThrottleConfig

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 ThrottleConfig

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) -> ThrottleConfig

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 ThrottleConfig

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 read(&self) -> Option<&ThrottleMode>

How the read (ingress) direction is throttled, if at all.

pub fn write(&self) -> Option<&ThrottleMode>

How the write (egress) direction is throttled, if at all.

pub fn quantum(&self) -> Option<u64>

The grant quantum override, if any.

Trait Implementations

impl Clone for ThrottleConfig

fn clone(&self) -> ThrottleConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThrottleConfig

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

Formats the value using the given formatter.

impl Default for ThrottleConfig

fn default() -> ThrottleConfig

Returns the “default value” for a type.