Skip to main content

UiEvent

Enum UiEvent 

Source
pub enum UiEvent {
Show 27 variants AssistantPartial { text: String, }, AssistantMessage { content: String, }, ToolCall { id: String, name: String, arguments: String, }, ToolResult { id: String, name: String, output: String, success: bool, }, Usage { input_tokens: u64, output_tokens: u64, }, Reasoning { content: String, }, Latency { llm_ms: u64, }, Compacted { removed: usize, kept: usize, }, TurnFinished, Error { message: String, }, PlanProposed { plan_text: String, tool_calls: Vec<Value>, }, PlanConfirmed, PlanRejected { reason: String, }, PlanModeRequested { reason: String, }, PlanModeApproved, PlanModeRejected { reason: String, }, TodoUpdated { todos: Vec<TodoItem>, }, GoalContinuing { reason: String, turns: u32, }, GoalAchieved { condition: String, turns: u32, }, GoalCleared, Interrupted, SessionResumed { session_id: String, turn_count: usize, }, McpServersLoaded { entries: Vec<McpEntry>, }, HookStarted { hook_event: String, hook_name: String, status_message: Option<String>, }, HookProgress { hook_event: String, hook_name: String, last_line: String, }, HookFinished { hook_event: String, hook_name: String, outcome: String, duration_ms: u64, }, HookSystemMessage { text: String, },
}
Expand description

Events bubbled up from the backend worker into the UI loop.

Variants§

§

AssistantPartial

A streamed partial token chunk to append to the in-flight assistant message.

Fields

§text: String
§

AssistantMessage

A completed assistant message (non-streaming providers, or the final flush after PartialToken chunks).

Fields

§content: String
§

ToolCall

Model requested to execute a tool. Carries the call id so the matching UiEvent::ToolResult can pair up.

Fields

§name: String
§arguments: String
§

ToolResult

Tool finished executing. id matches the originating UiEvent::ToolCall.

Fields

§name: String
§output: String
§success: bool
§

Usage

Token usage for the latest LLM call.

Fields

§input_tokens: u64
§output_tokens: u64
§

Reasoning

Reasoning / thinking content produced by the model for the current step (DeepSeek R1, OpenAI o1, …). Carries the full reasoning text; the TUI renders it as a thinking… block above the corresponding assistant message. Steps that did not produce reasoning never emit this event.

Fields

§content: String
§

Latency

Latency (ms) of the latest LLM call.

Fields

§llm_ms: u64
§

Compacted

Transcript compaction notification.

Fields

§removed: usize
§kept: usize
§

TurnFinished

Marks the end of a turn so the UI can stop the spinner.

§

Error

A non-fatal error worth surfacing to the user.

Fields

§message: String
§

PlanProposed

Goal-147: structured plan proposal from the runtime (AgentEvent::PlanProposed). The UI opens a Modal::PlanReview over the chat screen and freezes input until the user approves / rejects / edits.

tool_calls carries the pending tool calls as JSON values — each one has name, id, and arguments fields, mirroring the kernel’s serialised StepEvent::PlanProposed payload.

Fields

§plan_text: String
§tool_calls: Vec<Value>
§

PlanConfirmed

Goal-147: the runtime accepted the plan and resumed execution. Closes any open Modal::PlanReview and pushes a System block.

§

PlanRejected

Goal-147: the runtime rejected (or had its plan rejected) with a free-form reason. Same UI handling as PlanConfirmed plus the reason in the System block.

Fields

§reason: String
§

PlanModeRequested

Goal-202: agent called request_plan_mode; user should approve or skip.

Fields

§reason: String
§

PlanModeApproved

Goal-202: user approved the plan-mode entry request.

§

PlanModeRejected

Goal-202: user rejected the plan-mode entry request.

Fields

§reason: String
§

TodoUpdated

Goal-167: the agent updated its task list via todo_write. Carries the complete replacement list so the UI can re-render without a diff.

Fields

§todos: Vec<TodoItem>
§

GoalContinuing

Goal loop is running; the judge found the condition not yet met.

Fields

§reason: String
§turns: u32
§

GoalAchieved

Goal loop completed — condition confirmed met.

Fields

§condition: String
§turns: u32
§

GoalCleared

Active goal was cleared (budget exceeded, /goal clear, or API).

§

Interrupted

The current turn was aborted by the user (Esc/Ctrl+C). The backend cancelled the in-flight LLM request via JoinHandle::abort() and truncated the transcript back to the pre-turn state.

§

SessionResumed

A previous session was successfully loaded into the runtime. The UI should clear the in-progress transcript and show a System block.

Fields

§session_id: String
§turn_count: usize
§

McpServersLoaded

MCP server list loaded from the workspace config.

Fields

§entries: Vec<McpEntry>
§

HookStarted

A hook started executing.

Fields

§hook_event: String
§hook_name: String
§status_message: Option<String>
§

HookProgress

A hook produced incremental output (last stdout line).

Fields

§hook_event: String
§hook_name: String
§last_line: String
§

HookFinished

A hook finished executing.

Fields

§hook_event: String
§hook_name: String
§outcome: String
§duration_ms: u64
§

HookSystemMessage

The hook produced a system message to surface to the user.

Fields

§text: String

Trait Implementations§

Source§

impl Clone for UiEvent

Source§

fn clone(&self) -> UiEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UiEvent

Source§

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

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

impl Eq for UiEvent

Source§

impl PartialEq for UiEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for UiEvent

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

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

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