Struct ThrottleBudget 

pub struct ThrottleBudget { /* private fields */ }

Available on crate feature net only.

The StreamGate that throttles one direction of a single IO.

A ThrottledIo holds one per direction of a byte stream, and ThrottleGates opens one per stream direction of a multiplexed connection.

Must be polled within a tokio runtime context.

Implementations

impl ThrottleBudget

pub fn new(mode: ThrottleMode) -> ThrottleBudget

Create a ThrottleBudget spending from mode, with the default grant quantum.

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

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 ThrottleBudget

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

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 ThrottleBudget

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

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 ThrottleBudget

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 Debug for ThrottleBudget

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

Formats the value using the given formatter.

impl StreamGate for ThrottleBudget

fn poll_admit(&mut self, cx: &mut Context<'_>, want: u64) -> Poll<u64>

Sleeps until the bucket allows the next IO operation (up to) want bytes, at most the quantum. A pending operation settles zero, so an idle IO holds no capacity.

fn settle(&mut self, used: u64)

The unused remainder of the admission is refunded.