Enum MemoryBudget 

pub enum MemoryBudget {
    Auto,
    Bytes(u64),
    PercentTotal(f64),
    PercentAvailable(f64),
}

A requested memory limit.

Variants

Auto

Automatically use 80% of currently available memory.

Bytes(u64)

An absolute number of bytes.

PercentTotal(f64)

A fraction in (0, 1] of total physical capacity.

PercentAvailable(f64)

A fraction in (0, 1] of currently available capacity.

Implementations

impl MemoryBudget

pub const fn bytes(bytes: u64) -> MemoryBudget

Creates an absolute byte budget.

pub fn percent_total(percent: f64) -> Result<MemoryBudget, MemoryError>

Creates a percentage-of-total budget.

Errors

Returns MemoryError::InvalidBudget unless percent is in (0, 100].

pub fn percent_available(percent: f64) -> Result<MemoryBudget, MemoryError>

Creates a percentage-of-available budget.

Errors

Returns MemoryError::InvalidBudget unless percent is in (0, 100].

pub fn resolve(self, resource: &MemoryResource) -> Result<u64, MemoryError>

Resolves this request for a resource snapshot.

Errors

Returns an error for zero budgets, invalid percentages, or unavailable capacity telemetry.

Trait Implementations

impl Clone for MemoryBudget

fn clone(&self) -> MemoryBudget

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<(), Error>

Formats the value using the given formatter.

impl Default for MemoryBudget

fn default() -> MemoryBudget

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MemoryBudget

fn deserialize<__D>( __deserializer: __D, ) -> Result<MemoryBudget, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MemoryBudget

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

Formats the value using the given formatter.

impl FromStr for MemoryBudget

type Err = MemoryError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<MemoryBudget, <MemoryBudget as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for MemoryBudget

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MemoryBudget

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MemoryBudget