pub struct MemoryManager<M: MemoryMetrics> {
quota: MemoryQuotaState<M>,
}Expand description
Generic memory manager for quota-controlled operations.
Fields§
§quota: MemoryQuotaState<M>Implementations§
Source§impl<M: MemoryMetrics> MemoryManager<M>
impl<M: MemoryMetrics> MemoryManager<M>
Sourcepub fn new(limit_bytes: u64, metrics: M) -> Self
pub fn new(limit_bytes: u64, metrics: M) -> Self
Creates a new memory manager with the given limit in bytes.
limit_bytes = 0 disables the limit.
Sourcepub fn with_granularity(
limit_bytes: u64,
granularity: PermitGranularity,
metrics: M,
) -> Self
pub fn with_granularity( limit_bytes: u64, granularity: PermitGranularity, metrics: M, ) -> Self
Creates a new memory manager with specified granularity.
Sourcepub fn limit_bytes(&self) -> u64
pub fn limit_bytes(&self) -> u64
Returns the configured limit in bytes (0 if unlimited).
Sourcepub fn used_bytes(&self) -> u64
pub fn used_bytes(&self) -> u64
Returns currently used bytes.
Sourcepub fn available_bytes(&self) -> u64
pub fn available_bytes(&self) -> u64
Returns available bytes.
Unlimited managers report u64::MAX.
Sourcepub async fn acquire(&self, bytes: u64) -> Result<MemoryGuard<M>>
pub async fn acquire(&self, bytes: u64) -> Result<MemoryGuard<M>>
Acquires memory, waiting if necessary until enough is available.
§Errors
- Returns error if requested bytes exceed the total limit
- Returns error if the semaphore is unexpectedly closed
Sourcepub fn try_acquire(&self, bytes: u64) -> Option<MemoryGuard<M>>
pub fn try_acquire(&self, bytes: u64) -> Option<MemoryGuard<M>>
Tries to acquire memory. Returns Some(guard) on success, None if insufficient.
Sourcepub async fn acquire_with_policy(
&self,
bytes: u64,
policy: OnExhaustedPolicy,
) -> Result<MemoryGuard<M>>
pub async fn acquire_with_policy( &self, bytes: u64, policy: OnExhaustedPolicy, ) -> Result<MemoryGuard<M>>
Acquires 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 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)
Trait Implementations§
Source§impl<M: Clone + MemoryMetrics> Clone for MemoryManager<M>
impl<M: Clone + MemoryMetrics> Clone for MemoryManager<M>
Source§fn clone(&self) -> MemoryManager<M>
fn clone(&self) -> MemoryManager<M>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<M: MemoryMetrics + Default> Default for MemoryManager<M>
impl<M: MemoryMetrics + Default> Default for MemoryManager<M>
Auto Trait Implementations§
impl<M> Freeze for MemoryManager<M>where
M: Freeze,
impl<M> !RefUnwindSafe for MemoryManager<M>
impl<M> Send for MemoryManager<M>
impl<M> Sync for MemoryManager<M>
impl<M> Unpin for MemoryManager<M>where
M: Unpin,
impl<M> UnsafeUnpin for MemoryManager<M>where
M: UnsafeUnpin,
impl<M> !UnwindSafe for MemoryManager<M>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Applies the layer to a service and wraps it in [
Layered].