Struct ParamDecl 

pub struct ParamDecl {
    pub name: String,
    pub param_type: Option<String>,
    pub description: Option<String>,
    pub required: bool,
    pub default: Option<Value>,
    pub max_length: Option<u64>,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub enum_values: Option<Vec<Value>>,
}

Single [[tools.parameters]] entry.

The default and enum fields use toml::Value because they are heterogeneous in the reference configs (a default may be an integer, a string, or a boolean depending on the parameter type).

Fields

name: String

Parameter name (the :param token used in the tool’s sql).

param_type: Option<String>

JSON-schema type ("string", "integer", "number", "boolean").

description: Option<String>

Human-readable parameter description.

required: bool

Whether the parameter is required.

default: Option<Value>

Optional default value (any TOML type).

max_length: Option<u64>

Maximum string length (string parameters only).

minimum: Option<f64>

Inclusive minimum (integer / number parameters only).

maximum: Option<f64>

Inclusive maximum (integer / number parameters only).

enum_values: Option<Vec<Value>>

Closed set of allowed values (any TOML scalar).

Trait Implementations

impl Clone for ParamDecl

fn clone(&self) -> ParamDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamDecl

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

Formats the value using the given formatter.

impl Default for ParamDecl

fn default() -> ParamDecl

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParamDecl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParamDecl

fn eq(&self, other: &ParamDecl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ParamDecl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParamDecl