Enum ModelFrame 

pub enum ModelFrame {
    Input(ModelInput),
    GenerationStarted,
    ToolCall(ToolCall),
    GenerationFinished,
}

Native language-model protocol frames: one generation’s boundaries and the structured items it consumes or produces. On the data lane the exact interleaving is preserved:

Model(GenerationStarted)
Transcript(agent partial)
Model(ToolCall)
Transcript(agent final)
Model(GenerationFinished)

Text may come before or after a tool call, and a tool-call-only generation emits no transcript — so don’t assume text precedes tool calls. No generation id in v1: a stage runs one at a time, bounded by GenerationStarted / GenerationFinished.

Variants

Input(ModelInput)

Add non-user information to the LM conversation; see ModelInput.

GenerationStarted

Marks the beginning of one LM generation.

ToolCall(ToolCall)

A complete structured ToolCall emitted by the model.

GenerationFinished

Marks successful completion of the generation stream.

Implementations

impl ModelFrame

pub fn survives_flush(&self) -> bool

Model frames that outlive an interrupt flush: Input (external input) and ToolCall (a completed call). The generation boundaries belong to the interrupted turn and are dropped. Consulted by DataFrame::survives_flush.

Trait Implementations

impl Clone for ModelFrame

fn clone(&self) -> ModelFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelFrame

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

Formats the value using the given formatter.

impl Eq for ModelFrame

impl From<ModelFrame> for DataFrame

fn from(frame: ModelFrame) -> Self

Wrap a ModelFrame as a DataFrame::Model.

impl From<ToolCall> for ModelFrame

fn from(call: ToolCall) -> Self

Wrap a complete ToolCall as ModelFrame::ToolCall.

impl PartialEq for ModelFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModelFrame