Skip to main content

ResultMessage

Struct ResultMessage 

Source
pub struct ResultMessage {
Show 19 fields pub subtype: String, pub is_error: bool, pub result: Option<String>, pub errors: Option<Vec<Value>>, pub session_id: Option<String>, pub total_cost_usd: Option<f64>, pub ttft_ms: Option<u64>, pub duration_ms: Option<u64>, pub usage: Option<UsageSummary>, pub stop_reason: Option<String>, pub duration_api_ms: Option<u64>, pub num_turns: Option<u64>, pub terminal_reason: Option<String>, pub structured_output: Option<Value>, pub permission_denials: Vec<Value>, pub model_usage: Option<Value>, pub user_message_uuids: Vec<String>, pub origin: Option<Value>, pub extra: HashMap<String, Value>,
}
Expand description

Turn complete. Source: chunk-20bv8pca.js:14425–14913

Fields§

§subtype: String

“success” | “error_*”. A failed API call still comes as “success” with is_error: true and the message in result.

§is_error: bool§result: Option<String>

Final text of the turn, or the error message when is_error.

§errors: Option<Vec<Value>>

Error details of error_* subtypes.

§session_id: Option<String>§total_cost_usd: Option<f64>§ttft_ms: Option<u64>§duration_ms: Option<u64>§usage: Option<UsageSummary>§stop_reason: Option<String>§duration_api_ms: Option<u64>§num_turns: Option<u64>§terminal_reason: Option<String>

Why the loop ended (“completed”, …).

§structured_output: Option<Value>

Output matching Initialize::json_schema.

§permission_denials: Vec<Value>

Tool calls the permission system denied during the turn.

§model_usage: Option<Value>

Per-model token and cost breakdown.

§user_message_uuids: Vec<String>

The prompts (UserMessage::uuid) this turn answered.

§origin: Option<Value>

Set when the CLI started the turn itself (e.g. {"kind":"task-notification"} after a background task finished); absent for turns the host prompted.

§extra: HashMap<String, Value>

Implementations§

Source§

impl ResultMessage

Source

pub fn is_success(&self) -> bool

Source

pub fn answers(&self, uuid: &str) -> bool

Whether this turn answered the prompt uuid. A prompt the CLI refuses up front (e.g. budget spent) gets a result but no echo.

Source

pub fn error_kind(&self) -> TurnErrorKind

Category of a failed turn.

Source

pub fn error_message(&self) -> String

Why the turn failed: for is_error the CLI’s message; for error_* subtypes the subtype, then its errors details.

Trait Implementations§

Source§

impl Clone for ResultMessage

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 ResultMessage

Source§

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

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

impl Default for ResultMessage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ResultMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&ResultMessage> for TurnResult

Source§

fn from(r: &ResultMessage) -> Self

Converts to this type from the input type.
Source§

impl From<&ResultMessage> for TurnError

Source§

fn from(r: &ResultMessage) -> Self

Converts to this type from the input type.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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