Enum Unit 

pub enum Unit {
    Tokens,
    Usd,
    Wall,
    Calls,
}

Which of a budget’s four limits is being talked about.

Variants

Tokens

Tokens, prompt plus completion.

Usd

Spend, in micro-dollars.

Wall

Wall-clock time, in milliseconds.

Calls

Model calls.

Implementations

impl Unit

pub const ALL: [Self; 4]

Every unit, in a stable order.

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

The name BoundGraphError::BudgetExceeded reports. These strings are API.

pub fn from_name(name: &str) -> Option<Self>

The unit a name refers to.

The inverse of name, so a unit that crossed a process boundary as a string arrives back as the same unit.

pub const fn index(self) -> usize

This unit’s position in ALL.

Public because the runtime stores an amount per unit in a fixed array and needs the same ordering this crate uses — two orderings would be one too many.

pub fn render(self, amount: u64) -> String

How an amount in this unit should be written for a person.

The inverse of the normalisation Budget::amount applies, so a diagnostic reports $0.50 rather than 500000 usd.

Money is shown to at least two places and never fewer, because $0.5 reads as a typo where $0.50 reads as an amount. Sub-cent precision is kept where it exists — per-million token rates are quoted in millionths, and rounding them away in a diagnostic about cost would be the wrong place to lose them.

Trait Implementations

impl Clone for Unit

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 Unit

impl Debug for Unit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Unit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Unit

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

Formats the value using the given formatter.

impl Eq for Unit

impl Hash for Unit

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 Unit

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 Unit

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Unit

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 Serialize for Unit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Unit