Enum UiMessage 

pub enum UiMessage {
    TextChunk {
        session_id: i64,
        turn_id: Option<TurnId>,
        text: String,
        input_tokens: i64,
        output_tokens: i64,
    },
    Display {
        session_id: i64,
        turn_id: Option<TurnId>,
        message: String,
    },
    ToolExecuting {
        session_id: i64,
        turn_id: Option<TurnId>,
        tool_use_id: String,
        display_name: String,
        display_title: String,
    },
    ToolCompleted {
        session_id: i64,
        turn_id: Option<TurnId>,
        tool_use_id: String,
        status: ToolResultStatus,
        error: Option<String>,
    },
    Complete {
        session_id: i64,
        turn_id: Option<TurnId>,
        input_tokens: i64,
        output_tokens: i64,
        stop_reason: Option<String>,
    },
    TokenUpdate {
        session_id: i64,
        turn_id: Option<TurnId>,
        input_tokens: i64,
        output_tokens: i64,
        context_limit: i32,
    },
    Error {
        session_id: i64,
        turn_id: Option<TurnId>,
        error: String,
    },
    System {
        session_id: i64,
        message: String,
    },
    CommandComplete {
        session_id: i64,
        command: ControlCmd,
        success: bool,
        message: Option<String>,
    },
    UserInteractionRequired {
        session_id: i64,
        tool_use_id: String,
        request: AskUserQuestionsRequest,
        turn_id: Option<TurnId>,
    },
    PermissionRequired {
        session_id: i64,
        tool_use_id: String,
        request: PermissionRequest,
        turn_id: Option<TurnId>,
    },
    BatchPermissionRequired {
        session_id: i64,
        batch: BatchPermissionRequest,
        turn_id: Option<TurnId>,
    },
}

Messages sent from the controller to the TUI for display

Variants

TextChunk

Streaming text chunk from LLM response

Fields

session_id: i64

turn_id: Option<TurnId>

text: String

input_tokens: i64

output_tokens: i64

Display

General display message (tool status, info, etc.)

Fields

session_id: i64

turn_id: Option<TurnId>

message: String

ToolExecuting

Tool execution has started

Fields

session_id: i64

turn_id: Option<TurnId>

tool_use_id: String

display_name: String

display_title: String

ToolCompleted

Tool execution has completed

Fields

session_id: i64

turn_id: Option<TurnId>

tool_use_id: String

status: ToolResultStatus

error: Option<String>

Complete

LLM response is complete

Fields

session_id: i64

turn_id: Option<TurnId>

input_tokens: i64

output_tokens: i64

stop_reason: Option<String>

Stop reason from LLM - “tool_use” means tools will execute, “end_turn” means done

TokenUpdate

Real-time token count update

Fields

session_id: i64

turn_id: Option<TurnId>

input_tokens: i64

output_tokens: i64

context_limit: i32

Error

Error from the controller

Fields

session_id: i64

turn_id: Option<TurnId>

error: String

System

System message (TUI-local, not from controller)

Fields

session_id: i64

message: String

CommandComplete

Control command completed

Fields

session_id: i64

command: ControlCmd

success: bool

message: Option<String>

UserInteractionRequired

Tool is blocked waiting for user interaction (e.g., AskUserQuestions)

Fields

session_id: i64

tool_use_id: String

request: AskUserQuestionsRequest

turn_id: Option<TurnId>

PermissionRequired

Tool is blocked waiting for permission (e.g., AskForPermissions)

Fields

session_id: i64

tool_use_id: String

request: PermissionRequest

turn_id: Option<TurnId>

BatchPermissionRequired

Multiple tools are blocked waiting for batch permission. This is used when parallel tools need permissions - presenting all requests together avoids deadlocks and allows the user to make informed decisions.

Fields

session_id: i64

batch: BatchPermissionRequest

turn_id: Option<TurnId>

Trait Implementations

impl Clone for UiMessage

fn clone(&self) -> UiMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiMessage

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

Formats the value using the given formatter.