Struct TokenCounter

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

A simple token counter for tracking token usage in conversations

This is a very basic implementation that provides a minimal token counting utility. In a real-world scenario, you would want to use a proper tokenizer like tiktoken-rs for accurate token counting specific to the model being used.

§Examples

use language_barrier_core::TokenCounter;

let mut counter = TokenCounter::default();
counter.observe("Hello, world!");
assert_eq!(counter.total(), 2); // "Hello," and "world!" as two tokens

counter.subtract("Hello,");
assert_eq!(counter.total(), 1); // "world!" as one token

assert!(counter.under_budget(10)); // 1 < 10

Implementations§

Source§

impl TokenCounter

Source

pub fn new() -> Self

Creates a new TokenCounter with zero tokens

§Examples
use language_barrier_core::TokenCounter;

let counter = TokenCounter::new();
assert_eq!(counter.total(), 0);
Source

pub fn count_tokens(text: &str) -> usize

Counts the number of tokens in a string (naive implementation)

This is a very simple whitespace-based tokenization. In a real-world implementation, you would want to use a proper tokenizer like tiktoken-rs.

§Examples
use language_barrier_core::TokenCounter;

assert_eq!(TokenCounter::count_tokens("Hello, world!"), 2);
assert_eq!(TokenCounter::count_tokens("one two three four"), 4);
Source

pub fn observe(&mut self, text: &str)

Adds the token count of the given text to the total

§Examples
use language_barrier_core::TokenCounter;

let mut counter = TokenCounter::default();
counter.observe("Hello, world!");
assert_eq!(counter.total(), 2);
Source

pub fn subtract(&mut self, text: &str)

Subtracts the token count of the given text from the total

Will not go below zero (saturates at zero).

§Examples
use language_barrier_core::TokenCounter;

let mut counter = TokenCounter::default();
counter.observe("Hello, world!");
counter.subtract("Hello,");
assert_eq!(counter.total(), 1);

// Won't go below zero
counter.subtract("world! and more");
assert_eq!(counter.total(), 0);
Source

pub fn total(&self) -> usize

Returns the current total token count

§Examples
use language_barrier_core::TokenCounter;

let mut counter = TokenCounter::default();
counter.observe("Hello, world!");
assert_eq!(counter.total(), 2);
Source

pub fn under_budget(&self, max: usize) -> bool

Checks if the total token count is under the specified budget

§Examples
use language_barrier_core::TokenCounter;

let mut counter = TokenCounter::default();
counter.observe("Hello, world!");
assert!(counter.under_budget(5));
assert!(!counter.under_budget(1));

Trait Implementations§

Source§

impl Clone for TokenCounter

Source§

fn clone(&self) -> TokenCounter

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenCounter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TokenCounter

Source§

fn default() -> TokenCounter

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T