Skip to main content

ToolUseBlock

Struct ToolUseBlock 

Source
pub struct ToolUseBlock {
    pub id: String,
    pub name: String,
    pub input: Value,
}
Expand description

Tool use invocation block

Represents Claude invoking a tool (Read, Write, Edit, Bash, etc.)

§Example

{
  "type": "tool_use",
  "id": "toolu_abc123",
  "name": "Read",
  "input": {
    "file_path": "/path/to/file.rs"
  }
}
  • id links to ToolResultBlock.tool_use_id in user messages
  • id links to ProgressEvent.tool_use_id for progress updates

§Common Tool Names

  • Read - Read file contents
  • Write - Write new file
  • Edit - Edit existing file
  • Bash - Execute bash command
  • Glob - Search for files by pattern
  • Grep - Search file contents
  • TodoWrite - Update todo list
  • Agent - Spawn sub-agent

Fields§

§id: String

Unique tool use ID

Links to tool result in user message Format: "toolu_{random}" or "{tool_name}-{uuid}"

§name: String

Tool name

Common tools: Read, Write, Edit, Bash, Glob, Grep, Agent

§input: Value

Tool input parameters (JSON object)

Structure depends on tool type:

  • Read: {"file_path": "/path"}
  • Write: {"file_path": "/path", "content": "..."}
  • Edit: {"file_path": "/path", "old_string": "...", "new_string": "..."}
  • Bash: {"command": "cargo build", "description": "..."}

Trait Implementations§

Source§

impl Clone for ToolUseBlock

Source§

fn clone(&self) -> Self

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 ToolUseBlock

Source§

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

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

impl<'de> Deserialize<'de> for ToolUseBlock

Source§

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

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

impl Serialize for ToolUseBlock

Source§

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

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.