Struct ArgTransform 

pub struct ArgTransform {
    pub name: Option<String>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub hide: bool,
    pub required: Option<bool>,
    pub type_schema: Option<Value>,
}

Transformation rules for a single argument.

Use the builder methods to specify which aspects of the argument to transform. Any field left as None will inherit from the original argument.

Fields

name: Option<String>

New name for the argument.

description: Option<String>

New description for the argument.

default: Option<Value>

Default value (as JSON) for the argument.

hide: bool

Whether to hide this argument from the schema. Hidden arguments must have a default value.

required: Option<bool>

Override the required status. Only Some(true) is meaningful (to make optional → required).

type_schema: Option<Value>

New type annotation for the argument (as JSON Schema).

Implementations

impl ArgTransform

pub fn new() -> Self

Creates a new empty argument transform.

pub fn name(self, name: impl Into<String>) -> Self

Sets the new name for this argument.

pub fn description(self, desc: impl Into<String>) -> Self

Sets the new description for this argument.

pub fn default(self, value: impl Into<Value>) -> Self

Sets the default value for this argument.

pub fn default_str(self, value: impl Into<String>) -> Self

Sets a string default value.

pub fn default_int(self, value: i64) -> Self

Sets an integer default value.

pub fn default_bool(self, value: bool) -> Self

Sets a boolean default value.

pub fn hide(self) -> Self

Hides this argument from the schema.

Hidden arguments are not exposed to the LLM but must have a default value that will be used when the tool is called.

pub fn required(self) -> Self

Makes this argument required (even if it was optional).

pub fn type_schema(self, schema: Value) -> Self

Sets the JSON Schema type for this argument.

pub fn drop_with_default(value: impl Into<Value>) -> Self

Creates a transform that drops (hides) this argument with a default value.

Trait Implementations

impl Clone for ArgTransform

fn clone(&self) -> ArgTransform

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArgTransform

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

Formats the value using the given formatter.

impl Default for ArgTransform

fn default() -> ArgTransform

Returns the “default value” for a type.