Skip to main content

ToolServerHandle

Struct ToolServerHandle 

Source
pub struct ToolServerHandle(/* private fields */);
Expand description

The shareable, runtime-mutable tool registry.

Implementations§

Source§

impl ToolServerHandle

Source

pub fn attach(&self, bus: &Registrar)

Publish every registration onto bus, now and as they change.

Source

pub fn owner(&self) -> String

The registry’s label: the owner segment of the keys it mints.

Source

pub fn add_tool<T>(&self, tool: T)
where T: Tool + 'static,

Add a typed tool.

Source

pub fn add_dynamic_tool(&self, tool: DynamicTool)

Add a runtime-defined tool.

Source

pub fn add_registered_tool(&self, tool: RegisteredTool)

Add a registration built elsewhere.

Source

pub fn add_tools(&self, toolset: ToolSet)

Merge a tool set’s registrations.

Source

pub fn remove_tool(&self, tool_name: &str)

Remove the tool named tool_name.

Source

pub async fn execute( &self, tool_name: &str, args: &str, context: &mut ToolContext, ) -> ToolResult

Run tool_name inline, publishing its result metadata into context.

Source

pub fn snapshot(&self) -> ToolCatalog

The always-exposed registrations, pinned.

Source

pub fn static_tool_defs(&self) -> Vec<ToolDefinition>

The always-exposed definitions.

Source

pub fn toolset(&self) -> ToolSet

A fork of the registry’s tool set.

Source

pub async fn tool_defs( &self, prompt: Option<String>, ) -> Result<Vec<ToolDefinition>, ToolServerError>

Retrieve advertised definitions for prompt, returning retrieval failures or incompatible result shapes as definition errors.

Source

pub fn retrieval_keys(&self) -> Vec<HandlerKey>

Return registered retrieval index keys in registration order.

Source

pub fn retrieval_effects( &self, prompt: Option<String>, ) -> Vec<(HandlerKey, EffectKind)>

Build one TopNIds effect per retrieval index for the supplied prompt. Returns no effects without a prompt; pass returned IDs to Self::snapshot_with_dynamic after dispatch.

Source

pub fn snapshot_with_dynamic(&self, dynamic_tool_ids: &[String]) -> ToolCatalog

Pin retrieved tools in ID order, then always-exposed tools in registration order. Deduplicates names and skips missing registrations.

Trait Implementations§

Source§

impl Clone for ToolServerHandle

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 ManagedToolSink for ToolServerHandle

Source§

fn add_managed_tools( &self, tools: Vec<DynamicTool>, ) -> HashMap<String, ManagedToolToken>

Atomically install the initial tools owned by one source. Last-registration-wins: an existing name is replaced. Tools that report !is_live() are skipped. Returns one generation token per installed name, to hand back to Self::reconcile_managed_tools.
Source§

fn reconcile_managed_tools( &self, expected: HashMap<String, ManagedToolToken>, tools: Vec<DynamicTool>, ) -> HashMap<String, ManagedToolToken>

Atomically reconcile one source’s registrations with a refreshed tool list. Existing names change only while their expected generation is still current (newer local or peer-source registrations win); names missing from tools and still owned by this source are removed. Returns the new generation tokens.

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

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.
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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