Struct MemoryGuardConfig 

pub struct MemoryGuardConfig {
    pub limit_bytes: u64,
    pub pressure_threshold: f64,
    pub cgroup_headroom: f64,
}

Available on crate feature memory only.

Configuration for MemoryGuard.

When the config feature is enabled, this can be loaded from the config cascade under the memory key:

memory:
  limit_bytes: 0           # 0 = auto-detect from cgroup/system
  pressure_threshold: 0.80 # backpressure at 80% of effective limit
  cgroup_headroom: 0.85    # use 85% of cgroup limit

Fields

limit_bytes: u64

Explicit memory limit in bytes. 0 = auto-detect from cgroup/system.

pressure_threshold: f64

Fraction of limit at which backpressure activates (default 0.8).

cgroup_headroom: f64

Fraction of cgroup limit to use as the effective limit (default 0.85). Leaves headroom for the process itself (stack, code, etc.).

Implementations

impl MemoryGuardConfig

pub fn from_cascade() -> Self

Load from the config cascade, falling back to defaults.

When the config feature is enabled and config::setup() has been called, reads the memory key from the cascade. Otherwise returns MemoryGuardConfig::default().

pub fn from_env(prefix: &str) -> Self

Available on crate feature config only.

Create config from environment variables with a prefix.

Reads standard env vars for memory configuration:

• {PREFIX}_MEMORY_LIMIT_BYTES – explicit limit (0 or unset = auto-detect from cgroup)
• {PREFIX}_MEMORY_PRESSURE_THRESHOLD – backpressure trigger (default 0.80)
• {PREFIX}_MEMORY_CGROUP_HEADROOM – fraction of cgroup limit to use (default 0.85)

Example

DFE_MEMORY_LIMIT_BYTES=4294967296      # 4 GiB explicit
DFE_MEMORY_PRESSURE_THRESHOLD=0.75     # backpressure at 75%
DFE_MEMORY_CGROUP_HEADROOM=0.90        # use 90% of cgroup

use hyperi_rustlib::memory::MemoryGuardConfig;
let config = MemoryGuardConfig::from_env("DFE");

pub fn from_env_raw(prefix: &str) -> Self

Create config from environment variables without requiring config feature.

Same as from_env but uses std::env directly.

pub fn validate(&self) -> Result<(), String>

Validate the config, returning an error describing the first invalid field. pressure_threshold and cgroup_headroom must each be a finite fraction in (0.0, 1.0]. Call this at startup to fail fast on bad config rather than relying on MemoryGuard::new’s defensive clamping.

Errors

Returns Err with a human-readable message if a fraction field is non-finite, <= 0.0, or > 1.0.

Trait Implementations

impl Clone for MemoryGuardConfig

fn clone(&self) -> MemoryGuardConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryGuardConfig

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

Formats the value using the given formatter.

impl Default for MemoryGuardConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MemoryGuardConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MemoryGuardConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.