Struct TokenCount 

pub struct TokenCount(/* private fields */);

A count of tokens (for LLM context budgeting)

Implementations

impl TokenCount

pub const fn new(count: u32) -> Self

Create a new token count

pub const fn zero() -> Self

Create a zero token count

pub const fn get(self) -> u32

Get the inner value

pub const fn is_zero(self) -> bool

Check if this is zero

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating addition

pub fn percentage_of(self, total: Self) -> f32

Calculate percentage of another token count

Trait Implementations

impl Add for TokenCount

type Output = TokenCount

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for TokenCount

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for TokenCount

fn clone(&self) -> TokenCount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenCount

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

Formats the value using the given formatter.

impl Default for TokenCount

fn default() -> TokenCount

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenCount

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenCount

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

Formats the value using the given formatter.

impl From<TokenCount> for u32

fn from(value: TokenCount) -> Self

Converts to this type from the input type.

impl From<u32> for TokenCount

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for TokenCount

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 TokenCount

fn cmp(&self, other: &TokenCount) -> 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.

impl PartialEq for TokenCount

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TokenCount

fn partial_cmp(&self, other: &TokenCount) -> 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 TokenCount

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for TokenCount

type Output = TokenCount

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for TokenCount

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for TokenCount

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for TokenCount

impl Eq for TokenCount

impl StructuralPartialEq for TokenCount