Struct ToolResult 

pub struct ToolResult {
    pub tool_name: String,
    pub status: ToolStatus,
    pub data: Value,
    pub message: Option<String>,
    pub metadata: HashMap<String, Value>,
    pub suspension: Option<Box<SuspendTicket>>,
}

Result of tool execution.

Fields

tool_name: String

Tool name.

status: ToolStatus

Execution status.

data: Value

Result data.

message: Option<String>

Optional message.

metadata: HashMap<String, Value>

Metadata.

suspension: Option<Box<SuspendTicket>>

Structured suspension payload for loop-level suspension handling.

Implementations

impl ToolResult

pub fn success(tool_name: impl Into<String>, data: impl Into<Value>) -> Self

Create a success result.

pub fn success_with_message( tool_name: impl Into<String>, data: impl Into<Value>, message: impl Into<String>, ) -> Self

Create a success result with message.

pub fn error(tool_name: impl Into<String>, message: impl Into<String>) -> Self

Create an error result.

pub fn error_with_code( tool_name: impl Into<String>, code: impl Into<String>, message: impl Into<String>, ) -> Self

Create a structured error result with stable error code payload.

pub fn suspended( tool_name: impl Into<String>, message: impl Into<String>, ) -> Self

Create a suspended result (waiting for external resume/decision).

pub fn suspended_with( tool_name: impl Into<String>, message: impl Into<String>, ticket: SuspendTicket, ) -> Self

Create a suspended result carrying an explicit suspension envelope.

pub fn warning( tool_name: impl Into<String>, data: impl Into<Value>, message: impl Into<String>, ) -> Self

Create a warning result.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Add metadata.

pub fn with_suspension(self, ticket: SuspendTicket) -> Self

Attach structured suspension payload for loop-level suspension handling.

pub fn is_success(&self) -> bool

Check if execution succeeded.

pub fn is_pending(&self) -> bool

Check if execution is pending.

pub fn is_error(&self) -> bool

Check if execution failed.

pub fn suspension(&self) -> Option<SuspendTicket>

Structured suspension payload attached by with_suspension.

pub fn to_json(&self) -> Value

Convert to JSON value for serialization.

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> ToolResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolResult> for ToolExecutionEffect

fn from(result: ToolResult) -> Self

Converts to this type from the input type.

impl Serialize for ToolResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.