Skip to main content

ToolUnionParam

Enum ToolUnionParam 

Source
pub enum ToolUnionParam {
    CustomTool(ToolParam),
    Bash20241022(ToolBash20241022),
    Bash20250124(ToolBash20250124),
    TextEditor20250124(ToolTextEditor20250124),
    TextEditor20250429(ToolTextEditor20250429),
    TextEditor20250728(ToolTextEditor20250728),
    WebSearch20250305(WebSearchTool20250305),
}
Available on crate feature anthropic-client only.
Expand description

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§

Source§

impl ToolUnionParam

Source

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

Creates a new custom tool

Source

pub fn new_bash_20241022_tool() -> ToolUnionParam

Creates a new bash tool (version 20241022)

Source

pub fn new_bash_tool() -> ToolUnionParam

Creates a new bash tool (version 20250124)

Source

pub fn new_text_editor_tool() -> ToolUnionParam

Creates a new text editor tool

Source

pub fn new_text_editor_20250429_tool() -> ToolUnionParam

Creates a new text editor tool (version 20250429)

Source

pub fn new_text_editor_20250728_tool() -> ToolUnionParam

Creates a new text editor tool (version 20250728)

Source

pub fn new_web_search_tool() -> ToolUnionParam

Creates a new web search tool

Source

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§

Source§

impl Clone for ToolUnionParam

Source§

fn clone(&self) -> ToolUnionParam

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolUnionParam

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ToolUnionParam

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ToolUnionParam

Source§

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. Read more
Source§

impl StructuralPartialEq for ToolUnionParam

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,