Struct StructuredOutputProcessor 

pub struct StructuredOutputProcessor { /* private fields */ }

Per-request structured-output parser state.

Implementations

impl StructuredOutputProcessor

pub fn mask_logits( &self, logits: &mut [f32], generated: &[TokenId], ) -> Result<()>

Consume newly generated tokens and hard-mask every illegal next token. Waiting-for-reasoning mode leaves normal logits untouched until the typed delimiter has been observed.

pub fn mask_logits_with_terminals( &self, logits: &mut [f32], generated: &[TokenId], terminal_token_ids: &HashSet<u32>, hidden_control_token_ids: &HashSet<u32>, ) -> Result<StructuredOutputMaskOutcome>

Apply the grammar mask while allowing engine-resolved stop tokens once the grammar accepts. Some model templates use an end-of-turn token that is not the tokenizer’s primary EOS, so it cannot be represented by the grammar parser’s EOS set alone.

pub fn is_accepting(&self, generated: &[TokenId]) -> Result<bool>

True only when reasoning has closed and the grammar accepts the full generated structured value.

pub fn is_accepting_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<bool>

Completion check that treats an engine-resolved terminal sampled after grammar acceptance as framing rather than part of the JSON value.

pub fn progress_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<StructuredOutputProgress>

Inspect the typed activation/grammar state after consuming generated.

pub fn reset(&self) -> Result<()>

pub fn is_protocol_complete_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<bool>

Native framing can end inside an ordinary merged token instead of a model EOS ID. Only a complete native root authorizes this path.

pub fn complete_root_text_len_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<Option<usize>>

Byte end of a complete composed wire result, excluding an external model EOS. Text-stop handling can compare its cut position with this boundary without parsing tool markup as a final JSON value.

pub fn classified_result_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<Option<(StructuredOutputBranch, String)>>

Classify a complete non-native result with final-schema precedence. The returned payload preserves bytes from tokens spanning the reasoning/result boundary. Native protocols keep their own parser.

Trait Implementations

impl Debug for StructuredOutputProcessor

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

Formats the value using the given formatter.