Skip to main content

TurnEvent

Enum TurnEvent 

Source
pub enum TurnEvent {
Show 14 variants TextDelta(String), ReasoningDelta(String), ToolCallStreaming { name: String, hint: String, }, ToolCallStarted { id: String, name: String, arguments: String, }, ToolBatchStarted { batch_id: String, calls: Vec<ToolBatchCall>, }, ToolBatchCompleted { batch_id: String, ok: usize, total: usize, elapsed_ms: u64, }, ToolOutputChunk { call_id: String, chunk: String, }, ToolCallResult { call_id: String, name: String, output: String, success: bool, duration: Duration, }, Error(String), Warning(String), TokenUsage { prompt_tokens: usize, completion_tokens: usize, total_tokens: usize, cached_tokens: usize, }, ContextStats { system_tokens: usize, sent_tokens: usize, dropped_tokens: usize, working_set_tokens: usize, total_messages: usize, }, WorkingDirChanged(PathBuf), ApprovalRequested { tool_name: String, reason: String, call: ToolCall, messages: Vec<Message>, },
}
Expand description

Low-level events emitted by TurnRunner during execution. Does not contain approval events — approval is handled internally via PermissionDecider.

Variants§

§

TextDelta(String)

LLM streaming text output

§

ReasoningDelta(String)

LLM reasoning/thinking content (e.g., DeepSeek-R1, MiniMax-M2.7, o1-series). Emitted when the model produces thinking content separately from the final response. UI can optionally display this in verbose mode (Ctrl+O).

§

ToolCallStreaming

LLM has started emitting a tool call — name is known, arguments still streaming. Fires once per tool call, BEFORE the full args have arrived. Lets the UI surface the tool name immediately so users see “⠋ Write File…” instead of an opaque “Generating…” while the model spends seconds streaming args.

Fields

§name: String
§hint: String
§

ToolCallStarted

Tool call fully assembled, about to execute. id is the provider-supplied call id — pairs with the matching ToolCallResult.call_id.

Fields

§name: String
§arguments: String
§

ToolBatchStarted

Multiple tool calls fan out from one assistant message. Emitted BEFORE the per-call ToolCallStarted events, only when the runner is about to dispatch ≥ 2 non-duplicate calls. Lets the UI render a single grouped block instead of N independent rows. Per-call ToolCallStarted events STILL fire — UIs that don’t care about batches can ignore the batch events and render each call as today.

Fields

§batch_id: String
§

ToolBatchCompleted

Closes the batch opened by ToolBatchStarted. UI uses it to finalize the group header with ok / total / elapsed summary.

Fields

§batch_id: String
§total: usize
§elapsed_ms: u64
§

ToolOutputChunk

Real-time output chunk from a running tool (e.g., bash command). Sent during tool execution before ToolCallResult.

Fields

§call_id: String
§chunk: String
§

ToolCallResult

Tool call completed. call_id must equal the id emitted with the corresponding ToolCallStarted.

Fields

§call_id: String
§name: String
§output: String
§success: bool
§duration: Duration
§

Error(String)

Non-fatal error during execution

§

Warning(String)

Non-fatal advisory surfaced from a provider or other subsystem. TUI renders this as a one-line yellow banner; no turn failure. Currently used for “provider may be truncating input” detection.

§

TokenUsage

Token usage update

Fields

§prompt_tokens: usize
§completion_tokens: usize
§total_tokens: usize
§cached_tokens: usize
§

ContextStats

Context budget stats for logging

Fields

§system_tokens: usize
§sent_tokens: usize
§dropped_tokens: usize
§working_set_tokens: usize
§total_messages: usize
§

WorkingDirChanged(PathBuf)

Emitted when a tool mutated ctx.working_dir (e.g. change_dir or a bash call starting with cd). Lets the TUI footer track the current cwd without polling the shared Arc<RwLock<PathBuf>>.

§

ApprovalRequested

A tool requires user approval. Carries a snapshot of conversation.messages so the TUI can persist mid-turn session state (e.g. for /bg). The approval itself is handled by PermissionDecider; this event is purely informational.

Fields

§tool_name: String
§reason: String
§messages: Vec<Message>

Trait Implementations§

Source§

impl Clone for TurnEvent

Source§

fn clone(&self) -> TurnEvent

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 TurnEvent

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> Same for T

Source§

type Output = T

Should always be Self
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