Struct CustomTool 

pub struct CustomTool {
    pub name: String,
    pub description: Option<String>,
    pub defer_loading: Option<bool>,
    pub format: Option<CustomToolInputFormat>,
}

User-defined custom tool definition.

Spec: { name, type: "custom", defer_loading?, description?, format? }. The discriminator (type: "custom") is enforced by the parent ResponseTool enum; this struct only carries the payload fields so the flatten-style wire shape survives a round-trip.

Fields

name: String

Stable identifier the model uses to address this tool in custom_tool_call items.

description: Option<String>

Optional human-readable description supplied to the model.

defer_loading: Option<bool>

When true, the tool definition is deferred to a later tool_search-style fetch instead of being loaded inline.

format: Option<CustomToolInputFormat>

Optional input-format constraint — text (unconstrained) or grammar (Lark / regex production).

Trait Implementations

impl Clone for CustomTool

fn clone(&self) -> CustomTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CustomTool

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for CustomTool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.