ToolUseBlock

Struct ToolUseBlock 

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

Tool use request from the AI model.

When the model determines it needs to call a tool/function, it returns a ToolUseBlock specifying which tool to call and with what parameters. The application must then execute the tool and return results via ToolResultBlock.

§Fields

  • id: Unique identifier for this tool call, used to correlate results
  • name: Name of the tool to execute (must match a registered tool)
  • input: JSON parameters to pass to the tool

§Example

use open_agent::{ToolUseBlock, ContentBlock};
use serde_json::json;

let block = ToolUseBlock::new(
    "call_123",
    "calculate",
    json!({"expression": "2 + 2"})
);
assert_eq!(block.id, "call_123");
assert_eq!(block.name, "calculate");

Fields§

§id: String

Unique identifier for this tool call.

Generated by the model. Used to correlate the tool result back to this specific request, especially when multiple tools are called.

§name: String

Name of the tool to execute.

Must match the name of a tool that was provided in the agent’s configuration, otherwise execution will fail.

§input: Value

JSON parameters to pass to the tool.

The structure should match the tool’s input schema. The tool’s execution function receives this value as input.

Implementations§

Source§

impl ToolUseBlock

Source

pub fn new(id: impl Into<String>, name: impl Into<String>, input: Value) -> Self

Creates a new tool use block.

§Parameters
  • id: Unique identifier for this tool call
  • name: Name of the tool to execute
  • input: JSON parameters for the tool
§Example
use open_agent::ToolUseBlock;
use serde_json::json;

let block = ToolUseBlock::new(
    "call_abc",
    "search",
    json!({"query": "Rust async programming"})
);

Trait Implementations§

Source§

impl Clone for ToolUseBlock

Source§

fn clone(&self) -> ToolUseBlock

Returns a duplicate of the value. Read more
1.0.0 · 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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>,