Struct ChatTemplateResult 

pub struct ChatTemplateResult {
    pub prompt: String,
    pub grammar: Option<String>,
    pub grammar_lazy: bool,
    pub grammar_triggers: Vec<GrammarTrigger>,
    pub preserved_tokens: Vec<String>,
    pub additional_stops: Vec<String>,
    pub chat_format: i32,
    pub parser: Option<String>,
    pub thinking_forced_open: bool,
    pub parse_tool_calls: bool,
}

Result of applying a chat template with tool grammar support.

Fields

prompt: String

Rendered chat prompt.

grammar: Option<String>

Optional grammar generated from tool definitions.

grammar_lazy: bool

Whether to use lazy grammar sampling.

grammar_triggers: Vec<GrammarTrigger>

Lazy grammar triggers derived from the template.

preserved_tokens: Vec<String>

Tokens that should be preserved for sampling.

additional_stops: Vec<String>

Additional stop sequences added by the template.

chat_format: i32

Chat format used for parsing responses.

parser: Option<String>

Optional serialized PEG parser for tool-call parsing.

thinking_forced_open: bool

Whether the parser expects a forced-open thinking block.

parse_tool_calls: bool

Whether tool calls should be parsed from the response.

Implementations

impl ChatTemplateResult

pub fn parse_response_oaicompat( &self, text: &str, is_partial: bool, ) -> Result<String, ChatParseError>

Parse a generated response into an OpenAI-compatible message JSON string.

Errors

Returns an error if the FFI call fails or the result is null.

pub fn streaming_state_oaicompat( &self, ) -> Result<ChatParseStateOaicompat, ChatParseError>

Initialize a streaming parser for OpenAI-compatible chat deltas.

Errors

Returns an error if the parser state cannot be initialized.

impl ChatTemplateResult

pub fn build_grammar_sampler( &self, model: &LlamaModel, ) -> Result<(Option<LlamaSampler>, HashSet<LlamaToken>), GrammarSamplerError>

Builds a grammar sampler from this template result’s grammar and trigger configuration.

Returns None if no grammar is present. The returned HashSet contains preserved token IDs that should be decoded with special token handling.

Errors

Returns an error if trigger processing or grammar sampler initialization fails.

Trait Implementations

impl Clone for ChatTemplateResult

fn clone(&self) -> ChatTemplateResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatTemplateResult

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

Formats the value using the given formatter.

impl PartialEq for ChatTemplateResult

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

impl StructuralPartialEq for ChatTemplateResult