Enum ToolUnionParam 

pub enum ToolUnionParam {
    CustomTool(ToolParam),
    Bash20241022(ToolBash20241022),
    Bash20250124(ToolBash20250124),
    TextEditor20250124(ToolTextEditor20250124),
    TextEditor20250429(ToolTextEditor20250429),
    TextEditor20250728(ToolTextEditor20250728),
    WebSearch20250305(WebSearchTool20250305),
}

Union type for different tool parameter types.

This type represents a union of different tool types that can be used with Claude, including:

• Custom tools
• Bash tools
• Text editor tools
• Web search tools

The API accepts any of these tool types when tools are provided to Claude.

Variants

CustomTool(ToolParam)

A custom tool with a defined schema

Bash20241022(ToolBash20241022)

A bash tool for executing shell commands (version 20241022)

Bash20250124(ToolBash20250124)

A bash tool for executing shell commands (version 20250124)

TextEditor20250124(ToolTextEditor20250124)

A text editor tool for making changes to text

TextEditor20250429(ToolTextEditor20250429)

A text editor tool for making changes to text (version 20250429)

TextEditor20250728(ToolTextEditor20250728)

A text editor tool for making changes to text (version 20250728)

WebSearch20250305(WebSearchTool20250305)

A web search tool for retrieving information from the internet

Implementations

impl ToolUnionParam

pub fn new_custom_tool(name: String, input_schema: Value) -> Self

Creates a new custom tool

pub fn new_bash_20241022_tool() -> Self

Creates a new bash tool (version 20241022)

pub fn new_bash_tool() -> Self

Creates a new bash tool (version 20250124)

pub fn new_text_editor_tool() -> Self

Creates a new text editor tool

pub fn new_text_editor_20250429_tool() -> Self

Creates a new text editor tool (version 20250429)

pub fn new_text_editor_20250728_tool() -> Self

Creates a new text editor tool (version 20250728)

pub fn new_web_search_tool() -> Self

Creates a new web search tool

pub fn is_strict(&self) -> bool

Check if this tool has strict mode enabled.

Only custom tools can have strict mode enabled. All other tool types return false.

Trait Implementations

impl Clone for ToolUnionParam

fn clone(&self) -> ToolUnionParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolUnionParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolUnionParam

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolUnionParam

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

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 ToolUnionParam