Struct SchemaGenerator 

pub struct SchemaGenerator { /* private fields */ }

The main type used to generate JSON Schemas.

Example

use schemars::{JsonSchema, SchemaGenerator};

#[derive(JsonSchema)]
struct MyStruct {
    foo: i32,
}

let generator = SchemaGenerator::default();
let schema = generator.into_root_schema_for::<MyStruct>();

Implementations

impl SchemaGenerator

pub fn new(settings: SchemaSettings) -> SchemaGenerator

Creates a new SchemaGenerator using the given settings.

pub fn settings(&self) -> &SchemaSettings

Borrows the SchemaSettings being used by this SchemaGenerator.

Example

use schemars::SchemaGenerator;

let generator = SchemaGenerator::default();
let settings = generator.settings();

assert_eq!(settings.inline_subschemas, false);

pub fn subschema_for<T>(&mut self) -> Schema

where T: JsonSchema + ?Sized,

Generates a JSON Schema for the type T, and returns either the schema itself or a $ref schema referencing T’s schema.

If T is not inlined, this will add T’s schema to this generator’s definitions, and return a $ref schema referencing that schema. Otherwise, this method behaves identically to JsonSchema::json_schema.

If T’s schema depends on any non-inlined schemas, then this method will add them to the SchemaGenerator’s schema definitions.

pub fn definitions(&self) -> &Map<String, Value>

Borrows the collection of all non-inlined schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn definitions_mut(&mut self) -> &mut Map<String, Value>

Mutably borrows the collection of all non-inlined schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn take_definitions(&mut self, apply_transforms: bool) -> Map<String, Value>

Returns the collection of all non-inlined schemas that have been generated, leaving an empty Map in its place.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

To apply this generator’s transforms to each of the returned schemas, set apply_transforms to true.

pub fn transforms_mut( &mut self, ) -> impl Iterator<Item = &mut (dyn GenTransform + 'static)>

Returns an iterator over the transforms being used by this SchemaGenerator.

pub fn root_schema_for<T>(&mut self) -> Schema

where T: JsonSchema + ?Sized,

Generates a JSON Schema for the type T.

If T’s schema depends on any non-inlined schemas, then this method will include them in the returned Schema at the definitions path (by default "$defs").

pub fn into_root_schema_for<T>(self) -> Schema

where T: JsonSchema + ?Sized,

Consumes self and generates a JSON Schema for the type T.

If T’s schema depends on any non-inlined schemas, then this method will include them in the returned Schema at the definitions path (by default "$defs").

pub fn root_schema_for_value<T>(&mut self, value: &T) -> Result<Schema, Error>

where T: Serialize + ?Sized,

Generates a JSON Schema for the given example value.

If the value implements JsonSchema, then prefer using the root_schema_for() function which will generally produce a more precise schema, particularly when the value contains any enums.

If the Serialize implementation of the value decides to fail, this will return an Err.

pub fn into_root_schema_for_value<T>(self, value: &T) -> Result<Schema, Error>

where T: Serialize + ?Sized,

Consumes self and generates a JSON Schema for the given example value.

If the value implements JsonSchema, then prefer using the into_root_schema_for()! function which will generally produce a more precise schema, particularly when the value contains any enums.

If the Serialize implementation of the value decides to fail, this will return an Err.

pub fn contract(&self) -> &Contract

Returns a reference to the contract for the settings on this SchemaGenerator.

This specifies whether generated schemas describe serialize or deserialize behaviour.

Trait Implementations

impl Clone for SchemaGenerator

fn clone(&self) -> SchemaGenerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaGenerator

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

Formats the value using the given formatter.

impl Default for SchemaGenerator

fn default() -> SchemaGenerator

Returns the “default value” for a type.

impl From<SchemaSettings> for SchemaGenerator

fn from(settings: SchemaSettings) -> SchemaGenerator

Converts to this type from the input type.