Skip to main content

ToolResultExpanded

Struct ToolResultExpanded 

Source
pub struct ToolResultExpanded {
Show 17 fields pub binary_results_for_llm: Option<Vec<ExternalToolTextResultForLlmBinaryResultsForLlm>>, pub citable_sources: Option<Vec<Value>>, pub contents: Option<Vec<Value>>, pub error: Option<String>, pub mcp_meta: Option<HashMap<String, Value>>, pub new_messages: Option<Vec<ToolResultNewMessage>>, pub post_tool_use_failure_hooks_processed: Option<bool>, pub result_type: ToolResultType, pub session_log: Option<String>, pub skill_invocation: Option<Value>, pub skip_large_output_processing: Option<bool>, pub structured_content: Option<Value>, pub task_completion_decision: Option<TaskCompletionDecision>, pub text_result_for_llm: String, pub tool_references: Option<Vec<String>>, pub tool_telemetry: Option<Value>, pub ui_resource: Option<Value>,
}
Expand description

Expanded canonical result returned by a session tool.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields§

§binary_results_for_llm: Option<Vec<ExternalToolTextResultForLlmBinaryResultsForLlm>>

Base64-encoded binary results returned to the model.

§citable_sources: Option<Vec<Value>>

Sources returned by the tool that the model may cite.

§contents: Option<Vec<Value>>

Structured content blocks returned to the model.

§error: Option<String>

Error message for an unsuccessful execution.

§mcp_meta: Option<HashMap<String, Value>>

Metadata propagated with the tool result, including information-flow labels.

§new_messages: Option<Vec<ToolResultNewMessage>>

Messages to inject after the tool result.

§post_tool_use_failure_hooks_processed: Option<bool>

Whether post-tool-use failure hooks have already processed this result.

§result_type: ToolResultType

Execution outcome classification.

§session_log: Option<String>

Detailed log content available for session display.

§skill_invocation: Option<Value>

Skill invocation metadata produced by the tool.

§skip_large_output_processing: Option<bool>

Whether large-output post-processing should be skipped.

§structured_content: Option<Value>

Structured result content in addition to the model-facing text.

§task_completion_decision: Option<TaskCompletionDecision>

Completion-review decision produced by the task-completion tool.

§text_result_for_llm: String

Text result returned to the model.

§tool_references: Option<Vec<String>>

Deferred tool names made available by this result.

§tool_telemetry: Option<Value>

Tool-specific telemetry payload.

§ui_resource: Option<Value>

Optional UI resource produced by the tool.

Trait Implementations§

Source§

impl Clone for ToolResultExpanded

Source§

fn clone(&self) -> ToolResultExpanded

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 ToolResultExpanded

Source§

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

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

impl Default for ToolResultExpanded

Source§

fn default() -> ToolResultExpanded

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

impl<'de> Deserialize<'de> for ToolResultExpanded

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 Serialize for ToolResultExpanded

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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