Struct ElicitationSchema 

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

Elicitation schema - restricted subset of JSON Schema for primitive types only

Fields

schema_type: String

Schema type (must be “object”)

properties: HashMap<String, PrimitiveSchemaDefinition>

Schema properties (field definitions)

required: Option<Vec<String>>

Required field names

Implementations

impl ElicitationSchema

pub fn new() -> Self

Create a new elicitation schema

pub fn add_string_property<K: Into<String>>( self, name: K, required: bool, description: Option<String>, ) -> Self

Add a string property

pub fn add_number_property<K: Into<String>>( self, name: K, required: bool, description: Option<String>, min: Option<f64>, max: Option<f64>, ) -> Self

Add a number property

pub fn add_boolean_property<K: Into<String>>( self, name: K, required: bool, description: Option<String>, default: Option<bool>, ) -> Self

Add a boolean property

pub fn add_enum_property<K: Into<String>>( self, name: K, required: bool, description: Option<String>, values: Vec<String>, names: Option<Vec<String>>, ) -> Self

Add an enum property

Trait Implementations

impl Clone for ElicitationSchema

fn clone(&self) -> ElicitationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationSchema

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

Formats the value using the given formatter.

impl Default for ElicitationSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElicitationSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ElicitationSchema

fn eq(&self, other: &ElicitationSchema) -> 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 ElicitationSchema

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 ElicitationSchema