Struct MaxTokens 

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

Maximum number of response tokens requested from the model.

Implementations

impl MaxTokens

pub const MAX: usize

Highest token limit representable by the Swift bridge.

pub fn new(value: usize) -> Result<Self, Error>

Creates a token limit.

The Rust API stores token counts as usize, but the Swift bridge uses i64. This constructor rejects values that cannot cross that boundary without changing meaning.

Examples

use aimx::MaxTokens;

let max_tokens = MaxTokens::new(256)?;
assert_eq!(max_tokens.get(), 256);

Errors

Returns Error::InvalidMaxTokens when value is greater than MaxTokens::MAX.

pub fn get(self) -> usize

Returns the raw token count.

Trait Implementations

impl Clone for MaxTokens

fn clone(&self) -> MaxTokens

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaxTokens

impl Debug for MaxTokens

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

Formats the value using the given formatter.

impl Eq for MaxTokens

impl Hash for MaxTokens

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 MaxTokens

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MaxTokens

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

impl TryFrom<usize> for MaxTokens

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.