UiMessage

agent_core::agent

Enum UiMessage 

Source 
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>,
    },
}
Expand description

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>

Trait Implementations§

Source§

impl Clone for UiMessage

Source§

fn clone(&self) -> UiMessage

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 UiMessage

Source§

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

Formats the value using the given formatter. 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> 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> 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