Struct ToolResult 

pub struct ToolResult {
    pub structured: Map<String, Value>,
    pub hints: Vec<Hint>,
    pub is_error: bool,
}

A structured tool result. Hints live inside the structured object because clients drop the text content when structured content is present.

Fields

structured: Map<String, Value>

hints: Vec<Hint>

is_error: bool

Implementations

impl ToolResult

pub fn success(value: impl Serialize) -> Self

value must serialize to a JSON object.

pub fn error(error: Value) -> Self

A failed call’s result: {"error": error}.

pub fn with_hint(self, hint: Hint) -> Self

Adds one hint to the result.

pub fn with_hints(self, hints: impl IntoIterator<Item = Hint>) -> Self

Adds several hints to the result.

pub fn structured_content(&self) -> Value

The structured object as sent: the result fields, then hints.

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 From<ToolResult> for ToolOutcome

fn from(result: ToolResult) -> Self

Converts to this type from the input type.

impl PartialEq for ToolResult

fn eq(&self, other: &ToolResult) -> 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 StructuralPartialEq for ToolResult