Skip to main content

ToolDefaults

Struct ToolDefaults 

Source
pub struct ToolDefaults { /* private fields */ }
Expand description

Per-tool default kwargs for LLM-generated tool calls.

Defaults are stored as JSON objects (serde_json::Map<String, Value>). apply merges them into the caller-supplied args; caller-supplied keys win. null is a real value — passing {"timeout": null} will NOT be replaced by the registered default. To get the default, omit the key entirely.

Implementations§

Source§

impl ToolDefaults

Source

pub fn new() -> Self

Source

pub fn register(&mut self, tool_name: impl Into<String>, defaults: Value)

Register (or overwrite) defaults for tool_name.

defaults must be a JSON object (Value::Object); panics otherwise.

Source

pub fn register_many(&mut self, map: Value)

Register multiple tools at once from a JSON object of objects.

Source

pub fn update(&mut self, tool_name: impl Into<String>, extra: Value)

Merge new defaults into an existing registration (or create one).

Source

pub fn unregister(&mut self, tool_name: &str) -> bool

Drop a tool’s defaults. Returns true if it was registered.

Source

pub fn tool_names(&self) -> Vec<&str>

Sorted list of registered tool names.

Source

pub fn defaults_for(&self, tool_name: &str) -> Option<Map<String, Value>>

Copy of the defaults for tool_name.

Source

pub fn contains(&self, tool_name: &str) -> bool

Source

pub fn apply( &self, tool_name: &str, args: &Value, strict: bool, ) -> Result<Value, ToolNotRegisteredError>

Merge defaults into args. Caller-supplied keys win.

args must be a JSON object or Value::Null (treated as empty). Returns Err(ToolNotRegisteredError) if strict=true and tool not found. If strict=false and tool not found, returns args unchanged.

Trait Implementations§

Source§

impl Clone for ToolDefaults

Source§

fn clone(&self) -> ToolDefaults

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 ToolDefaults

Source§

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

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

impl Default for ToolDefaults

Source§

fn default() -> ToolDefaults

Returns the “default value” for a type. 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, 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> 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.