Skip to main content

MemoryGuard

Struct MemoryGuard 

Source
pub struct MemoryGuard { /* private fields */ }
Expand description

Thread-safe memory guard for monitoring and enforcing memory limits.

Implementations§

Source§

impl MemoryGuard

Source

pub fn new(config: MemoryGuardConfig) -> Self

Create a new memory guard with the given configuration.

Source

pub fn default_guard() -> Self

Create a memory guard with default configuration.

Source

pub fn with_limit(limit_mb: usize) -> Self

Create a memory guard with specified limit.

Source

pub fn shared(config: MemoryGuardConfig) -> Arc<Self>

Create an Arc-wrapped memory guard for sharing across threads.

Source

pub fn check(&self) -> Result<(), MemoryLimitExceeded>

Check memory limit (returns error if hard limit exceeded).

This should be called periodically during generation. It’s designed to be efficient - actual memory checks only happen at the configured interval.

Source

pub fn check_now(&self) -> Result<(), MemoryLimitExceeded>

Force an immediate memory check (bypasses interval).

Source

pub fn stats(&self) -> MemoryStats

Get current memory statistics.

Source

pub fn current_usage_mb(&self) -> usize

Get current memory usage in MB.

Source

pub fn peak_usage_mb(&self) -> usize

Get peak memory usage in MB.

Source

pub fn is_available() -> bool

Check if memory tracking is available on this platform.

Source

pub fn reset_stats(&self)

Reset statistics (for testing).

Trait Implementations§

Source§

impl Debug for MemoryGuard

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MemoryGuard

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V