Skip to main content

StreamEvent

Enum StreamEvent 

Source
pub enum StreamEvent {
Show 17 variants Start { partial: AssistantMessage, }, TextStart { content_index: usize, partial: AssistantMessage, }, TextDelta { content_index: usize, delta: String, partial: AssistantMessage, }, TextEnd { content_index: usize, content: String, partial: AssistantMessage, }, ThinkingStart { content_index: usize, partial: AssistantMessage, }, ThinkingDelta { content_index: usize, delta: String, partial: AssistantMessage, }, ThinkingEnd { content_index: usize, content: String, partial: AssistantMessage, }, ToolcallStart { content_index: usize, partial: AssistantMessage, }, ToolcallDelta { content_index: usize, delta: String, partial: AssistantMessage, }, ToolcallEnd { content_index: usize, tool_call: ToolCall, partial: AssistantMessage, }, ToolOutputDelta { tool_call_id: String, delta: String, }, ToolResult { tool_call_id: String, tool_name: String, is_error: bool, content: String, summary: Option<String>, }, Done { reason: StopReason, message: AssistantMessage, }, Error { reason: StopReason, error: AssistantMessage, }, SteerMessage { message: UserMessage, }, Phase { phase: AgentPhase, turn_started_at_ms: Option<u64>, phase_started_at_ms: Option<u64>, }, Status { message: String, },
}

Variants§

§

Start

Fields

§

TextStart

Fields

§content_index: usize
§

TextDelta

Fields

§content_index: usize
§delta: String
§

TextEnd

Fields

§content_index: usize
§content: String
§

ThinkingStart

Fields

§content_index: usize
§

ThinkingDelta

Fields

§content_index: usize
§delta: String
§

ThinkingEnd

Fields

§content_index: usize
§content: String
§

ToolcallStart

Fields

§content_index: usize
§

ToolcallDelta

Fields

§content_index: usize
§delta: String
§

ToolcallEnd

Fields

§content_index: usize
§tool_call: ToolCall
§

ToolOutputDelta

Incremental tool output line (streaming, e.g. bash).

Fields

§tool_call_id: String
§delta: String
§

ToolResult

Tool execution completed.

Fields

§tool_call_id: String
§tool_name: String
§is_error: bool
§content: String

Full text output.

§summary: Option<String>
§

Done

Fields

§reason: StopReason
§

Error

Fields

§reason: StopReason
§

SteerMessage

A steering message was injected mid-loop.

Fields

§message: UserMessage
§

Phase

Agent phase transition. Only sent for phases that have no implicit stream event (Waiting, Preparing, Connecting, Compacting). Other phases are derived by the TUI from existing events:

  • ThinkingStart/ThinkingDelta → Thinking
  • TextStart/TextDelta → Responding
  • ToolcallStart → Responding (still LLM output)
  • ToolResult → ToolExec
  • Start → transition from Connecting (but phase already set)
  • AgentDone/Cancelled/Error → Idle

turn_started_at_ms is the server-stamped wall-clock (Unix ms) when the current non-Idle turn began. It is preserved across phase→phase transitions within a single turn and cleared on transition to Idle. Used by clients to anchor the “Working… Xs” counter so it survives UI mode flicker and late subscribe.

phase_started_at_ms is the server-stamped wall-clock (Unix ms) when the current phase began. Re-stamped on every phase transition (Idle→Thinking, Thinking→ToolExec, etc.) and cleared on Idle. Used by clients to render a per-phase elapsed counter alongside the total turn elapsed so a slow tool call doesn’t keep climbing once the LLM resumes responding.

Fields

§turn_started_at_ms: Option<u64>
§phase_started_at_ms: Option<u64>
§

Status

Informational status message (e.g. retry notices).

Fields

§message: String

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> StreamEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamEvent

Source§

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

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

impl<'de> Deserialize<'de> for StreamEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for StreamEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,