Struct ElicitationSchema 

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

Restricted schema for elicitation requests Only allows flat objects with primitive properties

Fields

schema_type: String

Must always be “object” for elicitation schemas

properties: HashMap<String, PrimitiveSchemaDefinition>

Properties of the object - each must be a primitive schema

required: Option<Vec<String>>

Required property names

Implementations

impl ElicitationSchema

pub fn new() -> Self

Create a new elicitation schema

pub fn add_property( self, name: String, schema: PrimitiveSchemaDefinition, ) -> Self

Add a property to the schema

pub fn require(self, names: Vec<String>) -> Self

Mark properties as required

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 From<StringSchemaBuilder> for ElicitationSchema

World-class DX: Direct conversion to ElicitationSchema for single field usage

fn from(val: StringSchemaBuilder) -> Self

Converts to this type from the input type.

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.