Skip to main content

BudgetTracker

Struct BudgetTracker 

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

What one phase has spent so far. Shared by every task the phase runs.

Implementations§

Source§

impl BudgetTracker

Source

pub fn new(budget: Budget) -> Self

A tracker starting now.

Source

pub const fn budget(&self) -> &Budget

The limits in force.

Source

pub fn reserve(&self, depth: u8) -> Result<(), BudgetBound>

Reserves one call at depth.

§Errors

The BudgetBound that forbids it; the bound is also remembered for the report.

Source

pub async fn permit(&self) -> Option<SemaphorePermit<'_>>

Waits for a slot among the calls in flight.

Source

pub fn record_tokens(&self, tokens: u64)

Counts the prompt tokens a provider reported.

Source

pub fn remaining_wall_clock(&self) -> Option<Duration>

Time left on the wall clock, when it is bounded.

Source

pub fn call_timeout(&self, requested: Option<Duration>) -> Duration

The deadline of the next call: the per-call timeout, cut to the time left.

Source

pub fn exhausted(&self) -> Option<BudgetBound>

The first bound reached, if any.

Source

pub fn report(&self) -> BudgetReport

What was spent, for the replay record.

Trait Implementations§

Source§

impl Debug for BudgetTracker

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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