Struct ElicitFormSchema 

pub struct ElicitFormSchema {
    pub schema_type: String,
    pub properties: HashMap<String, PrimitiveSchemaDefinition>,
    pub required: Vec<String>,
}

Restricted JSON Schema for elicitation forms

Only allows top-level properties with primitive types.

Fields

schema_type: String

Must be “object”

properties: HashMap<String, PrimitiveSchemaDefinition>

Map of property names to their schema definitions

required: Vec<String>

List of required property names

Implementations

impl ElicitFormSchema

pub fn new() -> Self

Create a new form schema

pub fn string_field( self, name: &str, description: Option<&str>, required: bool, ) -> Self

Add a string field

pub fn string_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: &str, ) -> Self

Add a string field with a default value

pub fn integer_field( self, name: &str, description: Option<&str>, required: bool, ) -> Self

Add an integer field

pub fn integer_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: i64, ) -> Self

Add an integer field with a default value

pub fn number_field( self, name: &str, description: Option<&str>, required: bool, ) -> Self

Add a number field

pub fn number_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: f64, ) -> Self

Add a number field with a default value

pub fn boolean_field( self, name: &str, description: Option<&str>, required: bool, ) -> Self

Add a boolean field

pub fn boolean_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: bool, ) -> Self

Add a boolean field with a default value

pub fn enum_field( self, name: &str, description: Option<&str>, options: Vec<String>, required: bool, ) -> Self

Add a single-select enum field

pub fn enum_field_with_default( self, name: &str, description: Option<&str>, required: bool, options: &[&str], default: &str, ) -> Self

Add a single-select enum field with a default value

pub fn raw_field(self, name: &str, schema: Value, required: bool) -> Self

Add a raw JSON schema field

Use this for advanced schema features not covered by the typed builders.

Trait Implementations

impl Clone for ElicitFormSchema

fn clone(&self) -> ElicitFormSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitFormSchema

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

Formats the value using the given formatter.

impl Default for ElicitFormSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElicitFormSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ElicitFormSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.