Skip to main content

ArgTransform

Struct ArgTransform 

Source
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>,
}
Expand description

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§

Source§

impl ArgTransform

Source

pub fn new() -> ArgTransform

Creates a new empty argument transform.

Source

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

Sets the new name for this argument.

Source

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

Sets the new description for this argument.

Source

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

Sets the default value for this argument.

Source

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

Sets a string default value.

Source

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

Sets an integer default value.

Source

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

Sets a boolean default value.

Source

pub fn hide(self) -> ArgTransform

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.

Source

pub fn required(self) -> ArgTransform

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

Source

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

Sets the JSON Schema type for this argument.

Source

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

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

Trait Implementations§

Source§

impl Clone for ArgTransform

Source§

fn clone(&self) -> ArgTransform

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 ArgTransform

Source§

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

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

impl Default for ArgTransform

Source§

fn default() -> ArgTransform

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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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 = 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> 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