Struct MemoryBudget 

pub struct MemoryBudget { /* private fields */ }

A validated upper bound for memory retained by one execution context.

Implementations

impl MemoryBudget

pub const fn new(bytes: usize) -> Result<Self, MemoryBudgetError>

Creates a non-zero budget.

There is no compile-time maximum. A ceiling written into a library is a ceiling nobody can raise, and a caller reading a hundred-gigabyte entry needs a working set no constant here could have anticipated.

Errors

Returns MemoryBudgetError::Zero when bytes is zero, because a zero-byte budget cannot make forward progress.

pub const fn bytes(self) -> usize

Returns the maximum number of retained bytes.

pub fn auto() -> Self

The budget this process uses when the caller sets none.

MOLFRAME_MEMORY_BUDGET wins when it parses (see MemoryBudget::parse); an unparsable value is reported once on stderr and ignored. Otherwise the budget is MemoryBudget::for_physical_memory of the physical memory this process may use: the container limit when one is set, available memory on Linux, total memory on macOS. A platform that cannot report memory gets 1 GiB.

pub fn for_physical_memory(physical_bytes: usize) -> Self

Forty percent of physical_bytes, clamped to 100 MB through 512 GiB.

pub fn parse(text: &str) -> Result<Self, MemoryBudgetError>

Parses a byte count such as 123456, 512MB, 4GiB or 1.5G.

KB, MB, GB, TB are powers of 1000; K, KiB and so on, and a bare K/M/G/T, are powers of 1024.

Errors

Returns MemoryBudgetError::Zero for zero and MemoryBudgetError::Unparsable for anything else that is not a size.

Trait Implementations

impl Clone for MemoryBudget

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryBudget

impl Debug for MemoryBudget

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

Formats the value using the given formatter.

impl Default for MemoryBudget

fn default() -> Self

The machine-scaled budget of MemoryBudget::auto.

impl Eq for MemoryBudget

impl PartialEq for MemoryBudget

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MemoryBudget