Skip to main content

Budget

Struct Budget 

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

A memory budget for a single engine.

Tracks current allocation against a configurable limit using atomic counters (safe to read from any thread — metrics exporter, governor, etc.).

The allocated counter is stored behind an Arc so that ReservationToken can hold a reference to it without requiring a back-reference to the governor.

Implementations§

Source§

impl Budget

Source

pub fn new(limit: usize) -> Self

Create a new budget with the given limit.

Source

pub fn try_reserve(&self, size: usize) -> bool

Try to reserve size bytes from this budget.

Returns true if the reservation succeeded, false if it would exceed the limit.

Source

pub fn try_reserve_arc(&self, size: usize) -> Option<Arc<AtomicUsize>>

Try to reserve size bytes and return a shared Arc to the allocated counter so the caller can decrement it on drop.

Returns Some(arc) on success, None on budget exhaustion.

Source

pub fn release(&self, size: usize)

Release size bytes back to the budget.

Saturates to zero if size exceeds the current allocation (which can happen when data is replayed from WAL without a matching reservation).

Source

pub fn allocated(&self) -> usize

Current allocated bytes.

Source

pub fn limit(&self) -> usize

Hard limit in bytes.

Source

pub fn over_release_count(&self) -> usize

Number of over-release events observed on this budget. A non-zero value is the smoking-gun signal that some call-site is releasing more bytes than it reserved. Per-engine allocated() saturates to zero on over-release, so this counter is the only post-hoc observable.

Source

pub fn available(&self) -> usize

Remaining bytes available.

Source

pub fn utilization_percent(&self) -> u8

Utilization as a percentage (0-100).

Computed in u128 so a corrupted (e.g. underflow-wrapped near usize::MAX) allocated clamps to 100 % rather than panicking on allocated * 100 overflow — a panic here is taken inside the Data Plane core loop (apply_spsc_pressuresnapshot) and escalates to a DEGRADED core.

Source

pub fn peak(&self) -> usize

Peak allocation (high-water mark).

Source

pub fn rejections(&self) -> usize

Number of rejected allocation attempts.

Source

pub fn set_limit(&self, new_limit: usize)

Update the limit dynamically (for rebalancing).

The new limit must be >= current allocation. If it’s less, the limit is set to the current allocation (no immediate eviction).

Trait Implementations§

Source§

impl Debug for Budget

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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

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