Struct MemoryGuard 

pub struct MemoryGuard<M: MemoryMetrics> {
    pub(crate) state: GuardState<M>,
}

Guard representing a slice of reserved memory.

Fields

state: GuardState<M>

Implementations

impl<M: MemoryMetrics> MemoryGuard<M>

pub(crate) fn unlimited(quota: UnlimitedMemoryQuota<M>, bytes: u64) -> Self

pub(crate) fn limited( quota: MemoryQuota<M>, permit: OwnedSemaphorePermit, ) -> Self

pub fn granted_bytes(&self) -> u64

Returns granted quota in bytes.

pub async fn acquire_additional(&mut self, bytes: u64) -> Result<()>

Acquires additional memory, waiting if necessary until enough is available.

On success, merges the new memory into this guard.

Errors

• Returns error if requested bytes would exceed the manager’s total limit
• Returns error if the semaphore is unexpectedly closed

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

Tries to acquire additional memory without waiting.

On success, merges the new memory into this guard and returns true. On failure, returns false and leaves this guard unchanged.

pub async fn acquire_additional_with_policy( &mut self, bytes: u64, policy: OnExhaustedPolicy, ) -> Result<()>

Acquires additional memory based on the given policy.

• For OnExhaustedPolicy::Wait: Waits up to the timeout duration for memory to become available
• For OnExhaustedPolicy::Fail: Returns immediately if memory is not available

Errors

• MemoryLimitExceeded: Requested bytes would exceed the total limit (both policies), or memory is currently exhausted (Fail policy only)
• MemoryAcquireTimeout: Timeout elapsed while waiting for memory (Wait policy only)
• MemorySemaphoreClosed: The internal semaphore is unexpectedly closed (rare, indicates system issue)

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

Releases a portion of granted memory back to the pool before the guard is dropped.

Returns true if the release succeeds or is a no-op; false if the request exceeds granted.

Trait Implementations

impl<M: MemoryMetrics> Debug for MemoryGuard<M>

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

Formats the value using the given formatter.

impl<M: MemoryMetrics> Drop for MemoryGuard<M>

fn drop(&mut self)

Executes the destructor for this type.