Skip to main content

AllocationBudget

Struct AllocationBudget 

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

Allocation budget monitor with dual CUSUM + e-process detection.

Implementations§

Source§

impl AllocationBudget

Source

pub fn new(config: BudgetConfig) -> Self

Create monitor with default config.

Source

pub fn with_evidence_sink(self, sink: EvidenceSink) -> Self

Attach an evidence sink for JSONL logging.

Source

pub fn with_evidence_context( self, run_id: impl Into<String>, screen_mode: impl Into<String>, cols: u16, rows: u16, ) -> Self

Set evidence context fields for JSONL logs.

Source

pub fn set_evidence_context( &mut self, run_id: impl Into<String>, screen_mode: impl Into<String>, cols: u16, rows: u16, )

Set evidence context fields for JSONL logs.

Source

pub fn set_evidence_sink(&mut self, sink: Option<EvidenceSink>)

Set or clear the evidence sink.

Source

pub fn observe(&mut self, x: f64) -> Option<BudgetAlert>

Observe an allocation count/byte measurement for the current frame. Returns Some(alert) if a regression is detected.

Source

pub fn running_mean(&self) -> f64

Running mean of the observation window.

Source

pub fn e_value(&self) -> f64

Current e-process value.

Source

pub fn cusum_plus(&self) -> f64

Current CUSUM S⁺ value.

Source

pub fn cusum_minus(&self) -> f64

Current CUSUM S⁻ value.

Source

pub fn frames(&self) -> u64

Total frames observed.

Source

pub fn total_alerts(&self) -> u64

Total alerts fired.

Source

pub fn ledger(&self) -> &VecDeque<BudgetEvidence>

Access the evidence ledger.

Source

pub fn reset(&mut self)

Reset all state (keep config).

Source

pub fn summary(&self) -> BudgetSummary

Summary for diagnostics.

Trait Implementations§

Source§

impl Clone for AllocationBudget

Source§

fn clone(&self) -> AllocationBudget

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 Debug for AllocationBudget

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

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