Skip to main content

Tool

Struct Tool 

Source
pub struct Tool {
    pub id: CallId,
    pub call: FunctionCall,
    pub status: ToolStatus,
}
Expand description

A tool invocation paired with its lifecycle state.

Replaces the previous split of PartEnum::FunctionCall and PartEnum::FunctionResponse. Call and result live on the same part; the status field tracks where the tool is in its lifecycle (waiting for human approval, running, completed, rejected, or failed).

Fields§

§id: CallId§call: FunctionCall§status: ToolStatus

Implementations§

Source§

impl Tool

Source

pub fn new(call: FunctionCall) -> Tool

Create a new Tool in Pending state from a model-emitted call. Uses the call’s existing id, or mints a fresh one.

Source

pub fn is_resolved(&self) -> bool

True if the Tool has reached a final state (Completed, Rejected, Failed). Resolved tools are safe to send on the wire.

Source

pub fn is_pending(&self) -> bool

Source

pub fn is_executing(&self) -> bool

True if the tool has been approved (or auto-approved) and is either queued or running.

Source

pub fn effective_call(&self) -> &FunctionCall

The call as it should actually be executed. Honors edits made during approval; otherwise returns the original model-emitted call.

Source

pub fn response(&self) -> Option<&FunctionResponse>

The successful response, if any. Returns None for any non-Completed state — including Failed and Rejected. Use Tool::to_tuple for the wire-ready projection.

Source

pub fn approve(&mut self, edited_call: Option<FunctionCall>)

Source

pub fn reject(&mut self, reason: Option<String>)

Source

pub fn mark_running(&mut self)

Source

pub fn complete(&mut self, response: FunctionResponse)

Source

pub fn fail(&mut self, error: impl Into<String>)

Source

pub fn to_tuple(&self) -> (FunctionCall, Option<FunctionResponse>)

Project the Tool into the (call, optional response) pair that providers put on the wire.

  • Completed → real response
  • Failed → synthesized error response carrying the error string
  • Rejected → synthesized error response noting the refusal
  • Pending / Approved / Running(call, None) — not ready

This is the only place in the codebase where lossy ToolStatus → wire conversion happens. Providers must not re-implement it.

Source

pub fn try_to_tuple( &self, ) -> Result<(FunctionCall, FunctionResponse), NonResolvedToolError>

Strict variant: errors if the Tool is not resolved. Use in provider request builders where sending a non-resolved Tool would be a bug.

Trait Implementations§

Source§

impl Clone for Tool

Source§

fn clone(&self) -> Tool

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 Tool

Source§

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

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

impl<'de> Deserialize<'de> for Tool

Source§

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

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

impl PartialEq for Tool

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Tool

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 Tool

Auto Trait Implementations§

§

impl Freeze for Tool

§

impl RefUnwindSafe for Tool

§

impl Send for Tool

§

impl Sync for Tool

§

impl Unpin for Tool

§

impl UnsafeUnpin for Tool

§

impl UnwindSafe for Tool

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, 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<M> MetaArg<M> for M

Source§

fn into_meta(self) -> M

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