Struct ByteGate 

pub struct ByteGate { /* private fields */ }

The gate. Cheap to clone-by-Arc; one per store.

Implementations

impl ByteGate

pub fn new(max_bytes: u64) -> ByteGate

A gate over max_bytes (rounded up to a whole unit; at least one unit, so a zero budget is a one-at-a-time gate rather than a closed door).

pub fn max_bytes(&self) -> u64

The budget, as enforced (unit-rounded).

pub async fn acquire(&self, bytes: u64) -> BytePermit

Hold bytes until the returned permit drops. A request above the budget clamps to the whole budget and proceeds once it has it.

pub fn held(&self) -> u64

Bytes held right now, by every live permit.

pub fn high_water(&self) -> u64

The most bytes ever held at once.

Trait Implementations

impl Debug for ByteGate

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

Formats the value using the given formatter.