Enum ToolResult 

#[non_exhaustive]
pub enum ToolResult {
    Output(ToolOutput),
    Effect(EffectRequest),
}

Result of a tool call.

Pure or low-risk work can return ToolResult::Output. Side-effecting tools should return ToolResult::Effect, allowing an outer harness to govern and execute the requested side effect.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Output(ToolOutput)

Immediate model-visible output.

Effect(EffectRequest)

Side-effect request for an outer harness.

Implementations

impl ToolResult

pub fn output_content(&self) -> Option<&str>

Returns model-visible text for immediate output results.

Effect results return None because the side effect has not executed.

pub fn content_or_empty(&self) -> &str

Returns model-visible text, or an empty string for effect requests that have not executed yet.

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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolResult

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

Formats the value using the given formatter.

impl From<&str> for ToolResult

fn from(content: &str) -> ToolResult

Converts to this type from the input type.

impl From<String> for ToolResult

fn from(content: String) -> ToolResult

Converts to this type from the input type.

impl From<ToolOutput> for ToolResult

fn from(output: ToolOutput) -> ToolResult

Converts to this type from the input type.

impl PartialEq for ToolResult

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for ToolResult

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for ToolResult

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for ToolResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolResult

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 ToolResult