Struct JsonSchema

pub struct JsonSchema {
    pub type: Type,
    pub items: Option<Value>,
    pub properties: Option<Value>,
    pub description: Option<String>,
    pub required: Option<Vec<String>>,
    pub regex: Option<String>,
    pub value: Option<String>,
    pub target: Option<String>,
    pub enum: Option<Vec<String>>,
}

Fields

type: Type

This is the type of output you’d like. string, number, integer, boolean are the primitive types and should be obvious. array and object are more interesting and quite powerful. They allow you to define nested structures. For array, you can define the schema of the items in the array using the items property. For object, you can define the properties of the object using the properties property.

items: Option<Value>

This is required if the type is "array". This is the schema of the items in the array. This is of type JsonSchema. However, Swagger doesn’t support circular references.

properties: Option<Value>

This is required if the type is "object". This specifies the properties of the object. This is a map of string to JsonSchema. However, Swagger doesn’t support circular references.

description: Option<String>

This is the description to help the model understand what it needs to output.

required: Option<Vec<String>>

This is a list of properties that are required. This only makes sense if the type is "object".

regex: Option<String>

This is a regex that will be used to validate data in question.

value: Option<String>

This the value that will be used in filling the property.

target: Option<String>

This the target variable that will be filled with the value of this property.

enum: Option<Vec<String>>

This array specifies the allowed values that can be used to restrict the output of the model.

Implementations

impl JsonSchema

pub fn new(type: Type) -> JsonSchema

Trait Implementations

impl Clone for JsonSchema

fn clone(&self) -> JsonSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonSchema

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

Formats the value using the given formatter.

impl Default for JsonSchema

fn default() -> JsonSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonSchema

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

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 JsonSchema