Skip to main content

ToolRuntime

Struct ToolRuntime 

Source
pub struct ToolRuntime<S>
where S: State,
{ pub state: S, pub tool_call_id: String, pub config: RunnableConfig, pub store: Option<Arc<dyn Store>>, /* private fields */ }
Expand description

Tool runtime context injected into tool execution

Provides access to graph state, configuration, and store during tool execution.

Fields§

§state: S

Current graph state (read-only snapshot)

§tool_call_id: String

Current tool call ID

§config: RunnableConfig

Runtime configuration

§store: Option<Arc<dyn Store>>

Cross-thread persistent store

Implementations§

Source§

impl<S> ToolRuntime<S>
where S: State,

Source

pub const fn new( state: S, tool_call_id: String, config: RunnableConfig, store: Option<Arc<dyn Store>>, stream_tx: Option<UnboundedSender<Value>>, tools_event_tx: Option<UnboundedSender<ToolsEvent>>, ) -> ToolRuntime<S>

Create a new ToolRuntime instance

§Arguments
  • state - Current graph state
  • tool_call_id - Tool call identifier
  • config - Runtime configuration
  • store - Optional cross-thread persistent store
  • stream_tx - Optional streaming sender for output deltas
  • tools_event_tx - Optional streaming sender for tool lifecycle events
Source

pub fn emit_output_delta(&self, delta: &str)

Emit tool output delta for streaming

Allows tools to stream intermediate results during execution. If no streaming channel is configured, this is a no-op.

§Arguments
  • delta - Output delta fragment to stream
Source

pub fn emit_tool_started(&self, tool_name: &str, node: &str, input: Value)

Emit tool started lifecycle event

Sends a [ToolsEvent::ToolStarted] through the tools event channel when one is configured. If no channel is available, this is a no-op.

§Arguments
  • tool_name - Name of the tool being started
  • node - Node name where the tool is executing
  • input - Tool input as JSON value
Source

pub fn emit_tool_finished(&self, output: Value, duration_ms: u64, success: bool)

Emit tool finished lifecycle event

Sends a [ToolsEvent::ToolFinished] through the tools event channel when one is configured. If no channel is available, this is a no-op.

§Arguments
  • output - Tool output as JSON value
  • duration_ms - Execution duration in milliseconds
  • success - Whether the tool execution succeeded

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for ToolRuntime<S>

§

impl<S> !UnwindSafe for ToolRuntime<S>

§

impl<S> Freeze for ToolRuntime<S>
where S: Freeze,

§

impl<S> Send for ToolRuntime<S>

§

impl<S> Sync for ToolRuntime<S>

§

impl<S> Unpin for ToolRuntime<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for ToolRuntime<S>
where S: UnsafeUnpin,

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> 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: Sized + 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: Sized + 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, 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