Enum BudgetLimit 

#[non_exhaustive]
pub enum BudgetLimit {
    ModelCalls,
    PromptTokens,
    WallClock,
}

Which bound of a ResourceBudget ran out.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ModelCalls

The turn made as many model calls as it was allowed.

PromptTokens

The turn sent as many prompt tokens as it was allowed.

WallClock

The turn took as long as it was allowed.

Implementations

impl BudgetLimit

pub const ALL: [Self; 3]

Every bound, in the order they are checked.

pub const fn as_str(self) -> &'static str

Stable snake-case name, safe on the wire and in a metric label.

pub fn into_error(self) -> OrchestratorError

The typed failure a turn stopped by this bound returns.

It is a PolicyError rather than an internal failure because that is what it is: a configured limit refused to let the turn continue, and the caller is entitled to know which one.

Trait Implementations

impl Clone for BudgetLimit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BudgetLimit

impl Debug for BudgetLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BudgetLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BudgetLimit

impl Hash for BudgetLimit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BudgetLimit

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BudgetLimit

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for BudgetLimit

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BudgetLimit