Skip to main content

ToolInvocation

Struct ToolInvocation 

Source
pub struct ToolInvocation {
    pub tool_use_id: String,
    pub metadata: Arc<ToolMetadata>,
    pub input: Value,
    pub ctx: ExecutionContext,
}
Expand description

One tool call’s identifier + descriptor + input + request-scope context.

tool_use_id carries the IR’s stable id so observability layers can correlate ToolStart / ToolComplete / ToolError events for the same dispatch even when several parallel calls share the same tool name. metadata is the dispatched tool’s full declarative descriptor — name / version / effect / idempotent / retry hint flow through the layer stack from a single source so OtelLayer, PolicyLayer, and retry middleware see one authoritative struct. Layers may mutate input (e.g. PII redaction).

Fields§

§tool_use_id: String

Stable tool-use id matching the originating ContentPart::ToolUse::id. Empty when the call did not originate from a model ToolUse block (e.g. recipe-driven direct dispatch); observability layers fall back to metadata.name in that case.

§metadata: Arc<ToolMetadata>

Full declarative descriptor of the tool being dispatched — shared via Arc so layers don’t pay a clone per pass.

§input: Value

JSON input payload.

§ctx: ExecutionContext

Request-scope state.

Implementations§

Source§

impl ToolInvocation

Source

pub const fn new( tool_use_id: String, metadata: Arc<ToolMetadata>, input: Value, ctx: ExecutionContext, ) -> Self

Bundle the fields.

Source

pub fn name(&self) -> &str

Tool name (shortcut for self.metadata.name.as_str()).

Source

pub fn version(&self) -> Option<&str>

Tool version (shortcut for self.metadata.version.as_deref()).

Trait Implementations§

Source§

impl Clone for ToolInvocation

Source§

fn clone(&self) -> ToolInvocation

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 ToolInvocation

Source§

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

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

impl Retryable for ToolInvocation

Source§

fn ctx(&self) -> &ExecutionContext

Borrow the ExecutionContext the retry loop checks for cancellation between attempts.
Source§

fn ctx_mut(&mut self) -> &mut ExecutionContext

Mutable handle so RetryService can stamp an idempotency key on first entry — every clone of the request that follows shares the stamped key, so vendor-side dedupe sees one logical call across N attempts.
Source§

impl<Inner> Service<ToolInvocation> for RetryToolService<Inner>
where Inner: Service<ToolInvocation, Response = Value, Error = Error> + Clone + Send + 'static, Inner::Future: Send + 'static,

Source§

type Response = Value

Responses given by the service.
Source§

type Error = Error

Errors produced by the service.
Source§

type Future = Pin<Box<dyn Future<Output = Result<Value, Error>> + Send>>

The future response value.
Source§

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, invocation: ToolInvocation) -> Self::Future

Process the request and return the response asynchronously. Read more
Source§

impl<S> Service<ToolInvocation> for ScopedToolService<S>
where S: Service<ToolInvocation, Response = Value, Error = Error> + Send + 'static, S::Future: Send + 'static,

Source§

type Response = Value

Responses given by the service.
Source§

type Error = Error

Errors produced by the service.
Source§

type Future = Pin<Box<dyn Future<Output = Result<Value, Error>> + Send>>

The future response value.
Source§

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, invocation: ToolInvocation) -> Self::Future

Process the request and return the response asynchronously. 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> 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> 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<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