Struct LlamaChatTemplate

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

A performance-friendly wrapper around LlamaModel::chat_template which is then fed into LlamaModel::apply_chat_template to convert a list of messages into an LLM prompt. Internally the template is stored as a CString to avoid round-trip conversions within the FFI.

Implementations

impl LlamaChatTemplate

pub fn new(template: &str) -> Result<Self, NulError>

Create a new template from a string. This can either be the name of a llama.cpp chat template like “chatml” or “llama3” or an actual Jinja template for llama.cpp to interpret.

pub fn as_c_str(&self) -> &CStr

Accesses the template as a c string reference.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Attempts to convert the CString into a Rust str reference.

pub fn to_string(&self) -> Result<String, Utf8Error>

Convenience method to create an owned String.

Trait Implementations

impl Clone for LlamaChatTemplate

fn clone(&self) -> LlamaChatTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LlamaChatTemplate

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

Formats the value using the given formatter.

impl Hash for LlamaChatTemplate

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 LlamaChatTemplate

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

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

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

impl StructuralPartialEq for LlamaChatTemplate