Skip to main content

ToolExecutionOutput

Struct ToolExecutionOutput 

Source
pub struct ToolExecutionOutput {
    pub result: ToolResult,
    pub next_provider_parts: Vec<ContentPart>,
}
Expand description

Output of an authorized tool execution that may carry a provider-neutral continuation artifact (ADR-051).

Most tools produce only the normal ToolResult. A tool like read_image additionally returns next_provider_parts — a Vec<ContentPart> that the agent delivers to the immediately following provider request exactly once and then discards.

The continuation artifact is never persisted in the session transcript, TLOG, UI, hooks, exports, or compaction. It exists solely for the next stream_with_tools call.

Fields§

§result: ToolResult

The normal textual tool result (same as ToolResult).

§next_provider_parts: Vec<ContentPart>

Provider-neutral content parts to carry to the next provider request. Empty for all existing tools.

Implementations§

Source§

impl ToolExecutionOutput

Source

pub fn success(content: impl Into<String>) -> Self

Creates an output with a successful text result and no continuation parts.

Source

pub fn error(content: impl Into<String>) -> Self

Creates an output with an error text result and no continuation parts.

Source

pub fn from_result(result: ToolResult) -> Self

Wraps an existing ToolResult with no continuation parts.

Trait Implementations§

Source§

impl Clone for ToolExecutionOutput

Source§

fn clone(&self) -> ToolExecutionOutput

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 ToolExecutionOutput

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> 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, 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 = 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.