Skip to main content

PlanBudget

Struct PlanBudget 

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

Cumulative budget for a chain of solves.

Tracks both the strictest per-call class allowance (max_class) and a count of remaining ops (remaining_ops). Each [try_consume] either succeeds (decrementing remaining_ops, updating worst_seen) or returns a BudgetExhausted error the caller can use to short-circuit the chain.

Implementations§

Source§

impl PlanBudget

Source

pub fn new(max_class: ComplexityClass, max_ops: usize) -> Self

Construct a fresh budget with the given per-call class ceiling and op-count allowance.

Source

pub fn try_consume( &mut self, class: ComplexityClass, ) -> Result<(), BudgetExhausted>

Attempt to consume one slot for an operation of the given class. Returns Ok(()) on success and decrements the remaining-op count; returns Err(BudgetExhausted) if the class exceeds the budget or no ops remain.

Source

pub const fn remaining_ops(&self) -> usize

Number of op-slots still available.

Source

pub const fn max_class(&self) -> ComplexityClass

Strictest per-call class allowed.

Source

pub const fn worst_seen(&self) -> Option<ComplexityClass>

Highest class consumed so far across the chain, or None if no ops have been consumed yet.

Source

pub const fn has_capacity(&self) -> bool

True iff the budget can still accept at least a Logarithmic op — i.e. there are ops remaining (since Logarithmic is the cheapest class and always within any sensible max_class). Useful for “should I even try the next iteration?” loop guards.

Trait Implementations§

Source§

impl Clone for PlanBudget

Source§

fn clone(&self) -> PlanBudget

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlanBudget

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V