Struct MemoryBudget 

pub struct MemoryBudget { /* private fields */ }

A weighted byte budget shared by concurrent work.

Implementations

impl MemoryBudget

pub fn new(total_bytes: u64) -> Self

Creates a budget with exactly total_bytes bytes.

pub fn from_probe( probe: &dyn MemoryProbe, fraction: f64, floor_bytes: u64, ) -> Self

Uses fraction of the probed bytes, with floor_bytes as a minimum.

pub fn total(&self) -> u64

Returns this budget’s byte capacity.

pub fn available(&self) -> u64

Returns the bytes not reserved at this moment.

pub fn acquire( &self, bytes: u64, cancel: &CancelToken, ) -> Result<MemoryPermit<'_>, MemoryError>

Waits for and reserves bytes until the returned permit is dropped.

Trait Implementations

impl Debug for MemoryBudget

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

Formats the value using the given formatter.