Skip to main content

Budget

Struct Budget 

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

The fuel of an evaluation attempt, on the request’s meter.

Fuel is normative (SPEC 15.12): the fuel of a cell’s evaluation is what its last, completed attempt charges (used), whatever number of times the engine restarted it. A request’s normative fuel is the sum of the evaluations it completes, and its limit (limit) is checked at every charge against a lower bound of that sum (each suspended evaluation will charge at least what its last attempt did), so a request fails with BudgetExceeded exactly when its normative fuel exceeds the limit. Separately the request’s work (every attempt, those discarded by a restart included, and the engine’s validation reads) has a limit of its own, which bounds the total cost. When either runs out, the request fails and stores nothing.

Implementations§

Source§

impl Budget

Source

pub fn new(fuel: u64) -> Budget

A budget of fuel units, with no work limit (for a runtime’s own tests; the engine makes the budget of a request from its configuration).

Source

pub fn charge(&mut self, steps: u64) -> Result<(), EvalError>

Charges steps units of work to this attempt. EvalError::BudgetExceeded when the request’s fuel (or its work) runs out: the budget is then exhausted for the rest of the request.

Source

pub fn used(&self) -> u64

The fuel this attempt has charged so far: at the end of a completed attempt, the normative fuel of the evaluation.

Source

pub fn remaining(&self) -> u64

The fuel left: the limit less the lower bound of the request’s normative fuel.

Source

pub fn limit(&self) -> u64

The request’s fuel limit.

Source

pub fn is_exhausted(&self) -> bool

Whether a charge has failed.

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

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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