Struct schemars::schema::RootSchema

pub struct RootSchema {
    pub meta_schema: Option<String>,
    pub schema: SchemaObject,
    pub definitions: Map<String, Schema>,
}

The root object of a JSON Schema document.

Fields

meta_schema: Option<String>

The $schema keyword.

See JSON Schema 8.1.1. The “$schema” Keyword.

schema: SchemaObject

The root schema itself.

definitions: Map<String, Schema>

The definitions keyword.

In JSON Schema draft 2019-09 this was replaced by $defs, but in Schemars this is still serialized as definitions for backward-compatibility.

See JSON Schema 8.2.5. Schema Re-Use With “$defs”, and JSON Schema (draft 07) 9. Schema Re-Use With “definitions”.

Trait Implementations

impl Clone for RootSchema

fn clone(&self) -> RootSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RootSchema

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

Formats the value using the given formatter.

impl Default for RootSchema

fn default() -> RootSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RootSchema where
    RootSchema: Default, 

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RootSchema

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<RootSchema> for RootSchema

fn eq(&self, other: &RootSchema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RootSchema) -> bool

This method tests for !=.

impl Serialize for RootSchema

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 RootSchema