Enum JsonSchema 

pub enum JsonSchema {
    String {
        description: Option<String>,
        pattern: Option<String>,
        min_length: Option<u64>,
        max_length: Option<u64>,
        enum_values: Option<Vec<String>>,
    },
    Number {
        description: Option<String>,
        minimum: Option<f64>,
        maximum: Option<f64>,
    },
    Integer {
        description: Option<String>,
        minimum: Option<i64>,
        maximum: Option<i64>,
    },
    Boolean {
        description: Option<String>,
    },
    Array {
        description: Option<String>,
        items: Option<Box<JsonSchema>>,
        min_items: Option<u64>,
        max_items: Option<u64>,
    },
    Object {
        description: Option<String>,
        properties: Option<HashMap<String, JsonSchema>>,
        required: Option<Vec<String>>,
        additional_properties: Option<bool>,
    },
}

A JSON Schema definition

Variants

String

String type

Fields

description: Option<String>

pattern: Option<String>

min_length: Option<u64>

max_length: Option<u64>

enum_values: Option<Vec<String>>

Number

Number type

Fields

description: Option<String>

minimum: Option<f64>

maximum: Option<f64>

Integer

Integer type

Fields

description: Option<String>

minimum: Option<i64>

maximum: Option<i64>

Boolean

Boolean type

Fields

description: Option<String>

Array

Array type

Fields

description: Option<String>

items: Option<Box<JsonSchema>>

min_items: Option<u64>

max_items: Option<u64>

Object

Object type

Fields

description: Option<String>

properties: Option<HashMap<String, JsonSchema>>

required: Option<Vec<String>>

additional_properties: Option<bool>

Implementations

impl JsonSchema

pub fn string() -> JsonSchema

Create a string schema

pub fn string_with_description(description: impl Into<String>) -> JsonSchema

Create a string schema with description

pub fn string_enum(values: Vec<String>) -> JsonSchema

Create a string enum schema

pub fn number() -> JsonSchema

Create a number schema

pub fn number_with_description(description: impl Into<String>) -> JsonSchema

Create a number schema with description

pub fn integer() -> JsonSchema

Create an integer schema

pub fn integer_with_description(description: impl Into<String>) -> JsonSchema

Create an integer schema with description

pub fn boolean() -> JsonSchema

Create a boolean schema

pub fn boolean_with_description(description: impl Into<String>) -> JsonSchema

Create a boolean schema with description

pub fn array(items: JsonSchema) -> JsonSchema

Create an array schema

pub fn array_with_description( items: JsonSchema, description: impl Into<String>, ) -> JsonSchema

Create an array schema with description

pub fn object() -> JsonSchema

Create an object schema

pub fn object_with_properties( properties: HashMap<String, JsonSchema>, ) -> JsonSchema

Create an object schema with properties

pub fn object_with_required( properties: HashMap<String, JsonSchema>, required: Vec<String>, ) -> JsonSchema

Create an object schema with properties and required fields

pub fn with_description(self, description: impl Into<String>) -> JsonSchema

Add description to any schema

pub fn with_minimum(self, minimum: f64) -> JsonSchema

Add minimum constraint to number schema

pub fn with_maximum(self, maximum: f64) -> JsonSchema

Add maximum constraint to number schema

pub fn with_properties( self, properties: HashMap<String, JsonSchema>, ) -> JsonSchema

Add properties to object schema

pub fn with_required(self, required: Vec<String>) -> JsonSchema

Add required fields to object schema

Trait Implementations

impl Clone for JsonSchema

fn clone(&self) -> JsonSchema

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<JsonSchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JsonSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.