Struct TokenId 

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

Represents a unique identifier for a token.

Token IDs 0-255 are reserved for single-byte tokens (raw bytes). IDs 256 and above are used for merged tokens created during BPE training.

Implementations

impl TokenId

pub fn new(value: u32) -> Self

Creates a new TokenId with the given value.

Arguments

• value - The raw numeric value for this token ID.

pub fn for_new_token(value: u32) -> Self

Creates a TokenId for a newly merged token.

This offsets the value by 256 to avoid colliding with the reserved single-byte token IDs (0-255).

Arguments

• value - The merge index (0-based), which will be offset by 256.

pub fn value(&self) -> u32

Returns the raw numeric value of this token ID.

Trait Implementations

impl Clone for TokenId

fn clone(&self) -> TokenId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenId

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

Formats the value using the given formatter.

impl Display for TokenId

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

Formats the value using the given formatter.

impl Hash for TokenId

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 TokenId

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

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

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

impl Eq for TokenId

impl StructuralPartialEq for TokenId