Skip to main content

MemoryGovernor

Struct MemoryGovernor 

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

The central memory governor.

Thread-safe: all budget operations use atomics internally.

Implementations§

Source§

impl MemoryGovernor

Source

pub fn new(config: GovernorConfig) -> Result<Self>

Create a new governor with the given configuration.

Source

pub fn try_reserve(&self, engine: EngineId, size: usize) -> Result<()>

Try to reserve size bytes for the given engine.

Returns Ok(()) if the reservation succeeded, or an error describing why it was rejected.

Source

pub fn release(&self, engine: EngineId, size: usize)

Release size bytes back to the given engine’s budget.

Source

pub fn budget(&self, engine: EngineId) -> Option<&Budget>

Get the budget for a specific engine.

Source

pub fn global_ceiling(&self) -> usize

Get the global ceiling.

Source

pub fn total_allocated(&self) -> usize

Total memory allocated across all engines.

Source

pub fn global_utilization_percent(&self) -> u8

Global utilization as a percentage (0-100).

Source

pub fn engine_pressure(&self, engine: EngineId) -> PressureLevel

Current pressure level for a specific engine.

Source

pub fn global_pressure(&self) -> PressureLevel

Current global pressure level.

Source

pub fn set_thresholds(&mut self, thresholds: PressureThresholds)

Set custom pressure thresholds.

Source

pub fn snapshot(&self) -> Vec<EngineSnapshot>

Snapshot of all engine budget states (for metrics/debugging).

Trait Implementations§

Source§

impl Debug for MemoryGovernor

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

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

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

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.

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<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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