AiSdkEncoder

Struct AiSdkEncoder 

Source
pub struct AiSdkEncoder { /* private fields */ }
Expand description

Stateful encoder for AI SDK v6 UI Message Stream protocol.

Tracks text block lifecycle (open/close) across tool calls, ensuring text-start and text-end are always properly paired. This mirrors the pattern used by AG-UI encoders for AG-UI.

§Text lifecycle rules

  • TextDelta with text closed → prepend text-start, open text
  • ToolCallStart with text open → prepend text-end, close text
  • RunFinish with text open → prepend text-end before finish
  • Error → terminal, no text-end needed

Implementations§

Source§

impl AiSdkEncoder

Source

pub fn new() -> Self

Create a new encoder.

The encoder is fully initialized when the first RunStart event arrives, which sets the message_id from the run ID.

Source

pub fn message_id(&self) -> &str

Get the message ID.

Source

pub fn on_agent_event(&mut self, ev: &AgentEvent) -> Vec<UIStreamEvent>

Convert an AgentEvent to UI stream events with proper text lifecycle.

Trait Implementations§

Source§

impl Debug for AiSdkEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AiSdkEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Transcoder for AiSdkEncoder

Source§

type Input = AgentEvent

Input item type consumed by this transcoder.
Source§

type Output = UIStreamEvent

Output item type produced by this transcoder.
Source§

fn transcode(&mut self, item: &AgentEvent) -> Vec<UIStreamEvent>

Map one input item to zero or more output items.
Source§

fn prologue(&mut self) -> Vec<Self::Output>

Events emitted before the input stream starts.
Source§

fn epilogue(&mut self) -> Vec<Self::Output>

Events emitted after the input stream ends.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more