Struct ResourceGuard 

pub struct ResourceGuard {
    max_memory_bytes: AtomicU64,
    current_memory_bytes: AtomicU64,
    reserved_bytes: AtomicU64,
    enforce_limits: AtomicBool,
    safety_margin: f32,
}

Resource guard for preventing system overload.

Tracks memory allocation and provides checks before large allocations.

Fields

max_memory_bytes: AtomicU64

current_memory_bytes: AtomicU64

reserved_bytes: AtomicU64

enforce_limits: AtomicBool

safety_margin: f32

Implementations

impl ResourceGuard

pub fn new() -> ResourceGuard

Creates a new resource guard with default limits.

pub fn with_max_memory(max_bytes: u64) -> ResourceGuard

Creates a resource guard with a specific memory limit.

pub fn with_safety_margin(self, margin: f32) -> ResourceGuard

Creates a resource guard with custom safety margin.

pub fn unguarded() -> ResourceGuard

Creates a resource guard that doesn’t enforce limits (for testing).

pub fn set_max_memory(&self, max_bytes: u64)

Sets the maximum memory limit.

pub fn max_memory(&self) -> u64

Gets the maximum memory limit.

pub fn current_memory(&self) -> u64

Gets the current tracked memory usage.

pub fn reserved_memory(&self) -> u64

Gets the currently reserved memory.

pub fn available_memory(&self) -> u64

Gets the effective available memory (max - current - reserved).

pub fn can_allocate(&self, bytes: u64) -> bool

Checks if a given allocation can proceed.

pub fn can_allocate_safe(&self, bytes: u64) -> Result<(), ResourceError>

Checks if an allocation can proceed, also checking system memory.

pub fn record_allocation(&self, bytes: u64)

Records a memory allocation.

pub fn record_deallocation(&self, bytes: u64)

Records a memory deallocation.

pub fn reserve(&self, bytes: u64) -> Result<ReservationGuard<'_>, ResourceError>

Reserves memory for a future allocation.

Returns a guard that releases the reservation on drop.

pub fn validate(&self, estimate: &MemoryEstimate) -> Result<(), ResourceError>

Validates a memory estimate before allocation.

pub fn max_safe_elements(&self, bytes_per_element: usize) -> usize

Returns the maximum safe element count for a given per-element byte cost.

pub fn set_enforce_limits(&self, enforce: bool)

Enables or disables limit enforcement.

pub fn is_enforcing(&self) -> bool

Returns whether limits are being enforced.

Trait Implementations

impl Debug for ResourceGuard

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

Formats the value using the given formatter.

impl Default for ResourceGuard

fn default() -> ResourceGuard

Returns the “default value” for a type.