Skip to main content

MemoryManager

Struct MemoryManager 

Source
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>

Source

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.

Source

pub fn with_granularity( limit_bytes: u64, granularity: PermitGranularity, metrics: M, ) -> Self

Creates a new memory manager with specified granularity.

Source

pub fn limit_bytes(&self) -> u64

Returns the configured limit in bytes (0 if unlimited).

Source

pub fn used_bytes(&self) -> u64

Returns currently used bytes.

Source

pub fn available_bytes(&self) -> u64

Returns available bytes.

Unlimited managers report u64::MAX.

Source

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
Source

pub fn try_acquire(&self, bytes: u64) -> Option<MemoryGuard<M>>

Tries to acquire memory. Returns Some(guard) on success, None if insufficient.

Source

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>

Source§

fn clone(&self) -> MemoryManager<M>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: MemoryMetrics + Default> Default for MemoryManager<M>

Source§

fn default() -> Self

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

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

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].
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more