Struct ElicitFormSchema 

pub struct ElicitFormSchema {
    pub properties: HashMap<String, PrimitiveSchemaDefinition>,
    pub required: Vec<String>,
    pub schema: Option<String>,
    /* private fields */
}

A restricted subset of JSON Schema. Only top-level properties are allowed, without nesting.

JSON schema

{
 "description": "A restricted subset of JSON Schema.\nOnly top-level properties are allowed, without nesting.",
 "type": "object",
 "required": [
   "properties",
   "type"
 ],
 "properties": {
   "$schema": {
     "type": "string"
   },
   "properties": {
     "type": "object",
     "additionalProperties": {
       "$ref": "#/$defs/PrimitiveSchemaDefinition"
     }
   },
   "required": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "type": {
     "type": "string",
     "const": "object"
   }
 }
}

Fields

properties: HashMap<String, PrimitiveSchemaDefinition>

required: Vec<String>

schema: Option<String>

Implementations

impl ElicitFormSchema

pub fn new( properties: HashMap<String, PrimitiveSchemaDefinition>, required: Vec<String>, schema: Option<String>, ) -> Self

pub fn type_(&self) -> &String

pub fn type_value() -> String

returns “object”

pub fn type_name() -> String

👎Deprecated since 0.8.0: Use type_value() instead.

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<'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.