Skip to main content

TurnResult

Struct TurnResult 

Source
#[non_exhaustive]
pub struct TurnResult {
Show 17 fields pub session_id: Option<String>, pub result: Option<String>, pub structured_output: Option<Value>, pub total_cost_usd: Option<f64>, pub ttft_ms: Option<u64>, pub duration_ms: Option<u64>, pub duration_api_ms: Option<u64>, pub num_turns: Option<u64>, pub input_tokens: Option<u64>, pub output_tokens: Option<u64>, pub cache_read_input_tokens: Option<u64>, pub cache_creation_input_tokens: Option<u64>, pub model_usage: Option<Value>, pub stop_reason: Option<String>, pub terminal_reason: Option<String>, pub permission_denials: Vec<Value>, pub origin: Option<Value>,
}
Expand description

Outcome of a finished turn, from its result frame.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§session_id: Option<String>

Session id the CLI reported.

§result: Option<String>

Final text of the turn.

§structured_output: Option<Value>

Output matching Initialize::json_schema.

§total_cost_usd: Option<f64>

Cost in USD (total_cost_usd).

§ttft_ms: Option<u64>

Time to first token, in milliseconds (ttft_ms).

§duration_ms: Option<u64>

Wall-clock duration of the turn, in milliseconds (duration_ms).

§duration_api_ms: Option<u64>

Time spent in API calls, in milliseconds (duration_api_ms).

§num_turns: Option<u64>

Agentic turns (model calls) the turn took.

§input_tokens: Option<u64>

usage.input_tokens.

§output_tokens: Option<u64>

usage.output_tokens.

§cache_read_input_tokens: Option<u64>

usage.cache_read_input_tokens.

§cache_creation_input_tokens: Option<u64>

usage.cache_creation_input_tokens.

§model_usage: Option<Value>

Per-model token and cost breakdown.

§stop_reason: Option<String>

stop_reason of the result frame.

§terminal_reason: Option<String>

Why the agent loop ended (terminal_reason, e.g. “completed”).

§permission_denials: Vec<Value>

Tool calls the permission system denied.

§origin: Option<Value>

Set when the CLI started the turn itself (e.g. after a background task finished); None for prompted turns.

Trait Implementations§

Source§

impl Clone for TurnResult

Source§

fn clone(&self) -> Self

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 TurnResult

Source§

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

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

impl From<&ResultMessage> for TurnResult

Source§

fn from(r: &ResultMessage) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TurnResult

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TurnResult

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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