Struct AgentToolResult 

pub struct AgentToolResult {
    pub success: bool,
    pub output: String,
    pub metadata: Option<Value>,
    pub content_blocks: Option<Vec<ContentBlock>>,
    pub terminate: bool,
}

Result of tool execution

Fields

success: bool

pub.

output: String

pub.

metadata: Option<Value>

pub.

content_blocks: Option<Vec<ContentBlock>>

Optional content blocks (e.g., image blocks) to include in the tool result message. When present, these are used as the content of the ToolResultMessage instead of wrapping output in a Text block.

terminate: bool

When true, signals that the agent loop should terminate after this batch of tool calls completes. Defaults to false so that the loop continues unless a tool explicitly opts-in to termination.

Implementations

impl AgentToolResult

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

TODO.

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

TODO.

pub fn with_metadata(self, metadata: Value) -> Self

TODO: document this function.

pub fn with_content_blocks(self, blocks: Vec<ContentBlock>) -> Self

TODO: document this function.

pub fn with_terminate(self) -> Self

Mark this result as requesting agent-loop termination.

Trait Implementations

impl Debug for AgentToolResult

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

Formats the value using the given formatter.

impl Display for AgentToolResult

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

Formats the value using the given formatter.