Struct ToolResultBlock 

pub struct ToolResultBlock {
    pub tool_use_id: String,
    pub cache_control: Option<CacheControlEphemeral>,
    pub content: Option<ToolResultBlockContent>,
    pub is_error: Option<bool>,
}

Available on crate feature anthropic-client only.

A block containing the result of a tool execution.

ToolResultBlock represents the output from executing a tool that was previously requested via a ToolUseBlock. It contains the tool’s response, which can be either successful output or an error indication.

Fields

tool_use_id: String

The ID of the tool use that this result is for.

This must match the ID from the corresponding ToolUseBlock.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block.

When set, this creates an ephemeral cache point that can be reused in subsequent requests to avoid reprocessing the tool result.

content: Option<ToolResultBlockContent>

The content of the tool result, which can be either a string or an array of content items.

This contains the actual output from the tool execution. It can be simple text or structured content including images and formatted text.

is_error: Option<bool>

Whether this tool result represents an error.

When true, indicates that the tool execution failed and the content contains error information rather than successful output.

Implementations

impl ToolResultBlock

pub fn new(tool_use_id: String) -> ToolResultBlock

Create a new ToolResultBlock with the given tool use ID.

pub fn with_cache_control( self, cache_control: CacheControlEphemeral, ) -> ToolResultBlock

Add a cache control to this tool result block.

pub fn with_string_content(self, content: String) -> ToolResultBlock

Add string content to this tool result block.

pub fn with_array_content(self, content: Vec<Content>) -> ToolResultBlock

Add array content to this tool result block.

pub fn with_text_content(self, text: TextBlock) -> ToolResultBlock

Add a single text content item to this tool result block.

pub fn with_error(self, is_error: bool) -> ToolResultBlock

Set this tool result block as an error.

Trait Implementations

impl Clone for ToolResultBlock

fn clone(&self) -> ToolResultBlock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolResultBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResultBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolResultBlock> for ContentBlock

fn from(block: ToolResultBlock) -> ContentBlock

Converts to this type from the input type.

impl PartialEq for ToolResultBlock

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolResultBlock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolResultBlock