Struct JsonSchema 

pub struct JsonSchema {

    pub schema: Option<String>,
    pub ref_: Option<String>,
    pub defs: Option<BTreeMap<String, JsonSchema>>,
    pub type_: Option<SchemaType>,
    pub properties: Option<BTreeMap<String, JsonSchema>>,
    pub required: Option<Vec<String>>,
    pub additional_properties: Option<AdditionalProperties>,
    pub items: Option<Box<JsonSchema>>,
    pub enum_: Option<Vec<String>>,
    pub minimum: Option<i128>,
    pub maximum: Option<u128>,
    pub one_of: Option<Vec<JsonSchema>>,
    pub any_of: Option<Vec<JsonSchema>>,
    pub all_of: Option<Vec<JsonSchema>>,
    pub description: Option<String>,
    pub title: Option<String>,
    pub const_: Option<String>,
}

A JSON Schema definition.

This is a simplified representation that covers the most common cases. It can be serialized to JSON using facet-json.

Fields

schema: Option<String>

The JSON Schema dialect

ref_: Option<String>

Reference to another schema definition

defs: Option<BTreeMap<String, JsonSchema>>

Schema definitions for reuse

type_: Option<SchemaType>

The type of the schema

properties: Option<BTreeMap<String, JsonSchema>>

For objects: the properties

required: Option<Vec<String>>

For objects: required property names

additional_properties: Option<AdditionalProperties>

For objects: additional properties schema or false

items: Option<Box<JsonSchema>>

For arrays: the items schema

enum_: Option<Vec<String>>

For strings: enumerated values

minimum: Option<i128>

For numbers: minimum value

maximum: Option<u128>

For numbers: maximum value

one_of: Option<Vec<JsonSchema>>

For oneOf/anyOf/allOf

any_of: Option<Vec<JsonSchema>>

all_of: Option<Vec<JsonSchema>>

description: Option<String>

Description from doc comments

title: Option<String>

Title (type name)

const_: Option<String>

Constant value

Implementations

impl JsonSchema

pub const fn new() -> Self

Create an empty schema

pub fn with_dialect(dialect: &str) -> Self

Create a schema with a $schema dialect

pub fn reference(ref_path: &str) -> Self

Create a reference to another 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

Formats the value using the given formatter.

impl Default for JsonSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'ʄ> Facet<'ʄ> for JsonSchema

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?