Struct ToolExample 

pub struct ToolExample {
    pub scenario: String,
    pub parameters: Value,
    pub explanation: String,
}

Represents a usage example for a tool

Each example demonstrates a specific scenario with parameters and an explanation of the expected outcome.

Fields

scenario: String

Description of the scenario/use case

parameters: Value

Example parameters in JSON format

explanation: String

Explanation of what this example does and why

Implementations

impl ToolExample

pub fn new( scenario: impl Into<String>, parameters: Value, explanation: impl Into<String>, ) -> Self

Creates a new tool example

Arguments

• scenario - Description of the use case
• parameters - JSON parameters for the example
• explanation - What this example accomplishes

Trait Implementations

impl Clone for ToolExample

fn clone(&self) -> ToolExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolExample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolExample

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolExample

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolExample