Struct StreamParser 

pub struct StreamParser { /* private fields */ }

Parses a model’s A2UI output incrementally, one chunk at a time.

Implementations

impl StreamParser

pub fn new(catalog: Catalog) -> Self

A parser for a stream of components drawn from catalog.

pub fn with_cuttable_keys<I, S>(self, keys: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Overrides which keys may have their string values closed early.

A catalog whose components carry long free-text properties under other names can add them here to keep those streaming smoothly.

pub fn without_validation(self) -> Self

Turns off validation, emitting whatever parses.

Only useful when the catalog is not known to this process; the filtering that validation provides is most of what makes partial output safe to render.

pub fn surface_id(&self) -> Option<&str>

The surface the stream is currently describing.

pub fn root_id(&self) -> &str

The root component id for the active surface.

pub fn process_chunk(&mut self, chunk: &str) -> Result<Vec<ResponsePart>>

Feeds the next chunk of the model’s output.

Returns the parts that became renderable because of this chunk: conversational text, complete A2UI messages, and partial updates that are safe to draw. An empty vector means the chunk did not complete anything.

Errors

Returns Error::Parse for a block that contained no JSON at all, and Error::Validation for output no further input can rescue: a message matching no envelope, a missing required envelope field, or a reference loop.

Trait Implementations

impl Clone for StreamParser

fn clone(&self) -> StreamParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamParser

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

Formats the value using the given formatter.