Struct schemars::gen::SchemaGenerator
source · [−]pub struct SchemaGenerator { /* private fields */ }
Expand description
The main type used to generate JSON Schemas.
Example
use schemars::{JsonSchema, gen::SchemaGenerator};
#[derive(JsonSchema)]
struct MyStruct {
foo: i32,
}
let gen = SchemaGenerator::default();
let schema = gen.into_root_schema_for::<MyStruct>();
Implementations
sourceimpl SchemaGenerator
impl SchemaGenerator
sourcepub fn new(settings: SchemaSettings) -> SchemaGenerator
pub fn new(settings: SchemaSettings) -> SchemaGenerator
Creates a new SchemaGenerator
using the given settings.
sourcepub fn settings(&self) -> &SchemaSettings
pub fn settings(&self) -> &SchemaSettings
Borrows the SchemaSettings
being used by this SchemaGenerator
.
Example
use schemars::gen::SchemaGenerator;
let gen = SchemaGenerator::default();
let settings = gen.settings();
assert_eq!(settings.option_add_null_type, true);
pub fn make_extensible(&self, _schema: &mut SchemaObject)
This method no longer has any effect.
pub fn schema_for_any(&self) -> Schema
Use Schema::Bool(true)
instead
pub fn schema_for_none(&self) -> Schema
Use Schema::Bool(false)
instead
sourcepub fn subschema_for<T: ?Sized + JsonSchema>(&mut self) -> Schema
pub fn subschema_for<T: ?Sized + JsonSchema>(&mut self) -> Schema
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 referenceable, 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 referenceable schemas, then this method will
add them to the SchemaGenerator
’s schema definitions.
sourcepub fn definitions(&self) -> &Map<String, Schema>
pub fn definitions(&self) -> &Map<String, Schema>
Borrows the collection of all referenceable schemas that have been generated.
The keys of the returned Map
are the schema names, and the values are the schemas
themselves.
sourcepub fn definitions_mut(&mut self) -> &mut Map<String, Schema>
pub fn definitions_mut(&mut self) -> &mut Map<String, Schema>
Mutably borrows the collection of all referenceable schemas that have been generated.
The keys of the returned Map
are the schema names, and the values are the schemas
themselves.
sourcepub fn take_definitions(&mut self) -> Map<String, Schema>
pub fn take_definitions(&mut self) -> Map<String, Schema>
Returns the collection of all referenceable 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.
sourcepub fn visitors_mut(&mut self) -> impl Iterator<Item = &mut dyn GenVisitor>
pub fn visitors_mut(&mut self) -> impl Iterator<Item = &mut dyn GenVisitor>
Returns an iterator over the visitors being used by this SchemaGenerator
.
sourcepub fn root_schema_for<T: ?Sized + JsonSchema>(&mut self) -> RootSchema
pub fn root_schema_for<T: ?Sized + JsonSchema>(&mut self) -> RootSchema
Generates a root JSON Schema for the type T
.
If T
’s schema depends on any referenceable schemas, then this method will
add them to the SchemaGenerator
’s schema definitions and include them in the returned SchemaObject
’s
definitions
sourcepub fn into_root_schema_for<T: ?Sized + JsonSchema>(self) -> RootSchema
pub fn into_root_schema_for<T: ?Sized + JsonSchema>(self) -> RootSchema
Consumes self
and generates a root JSON Schema for the type T
.
If T
’s schema depends on any referenceable schemas, then this method will
include them in the returned SchemaObject
’s definitions
sourcepub fn root_schema_for_value<T: ?Sized + Serialize>(
&mut self,
value: &T
) -> Result<RootSchema, Error>
pub fn root_schema_for_value<T: ?Sized + Serialize>(
&mut self,
value: &T
) -> Result<RootSchema, Error>
Generates a root 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.
sourcepub fn into_root_schema_for_value<T: ?Sized + Serialize>(
self,
value: &T
) -> Result<RootSchema, Error>
pub fn into_root_schema_for_value<T: ?Sized + Serialize>(
self,
value: &T
) -> Result<RootSchema, Error>
Consumes self
and generates a root 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.
sourcepub fn dereference<'a>(&'a self, schema: &Schema) -> Option<&'a Schema>
pub fn dereference<'a>(&'a self, schema: &Schema) -> Option<&'a Schema>
Attemps to find the schema that the given schema
is referencing.
If the given schema
has a $ref
property which refers
to another schema in self
’s schema definitions, the referenced schema will be returned. Otherwise, returns None
.
Example
use schemars::{JsonSchema, gen::SchemaGenerator};
#[derive(JsonSchema)]
struct MyStruct {
foo: i32,
}
let mut gen = SchemaGenerator::default();
let ref_schema = gen.subschema_for::<MyStruct>();
assert!(ref_schema.is_ref());
let dereferenced = gen.dereference(&ref_schema);
assert!(dereferenced.is_some());
assert!(!dereferenced.unwrap().is_ref());
assert_eq!(dereferenced, gen.definitions().get("MyStruct"));
Trait Implementations
sourceimpl Clone for SchemaGenerator
impl Clone for SchemaGenerator
sourceimpl Debug for SchemaGenerator
impl Debug for SchemaGenerator
sourceimpl Default for SchemaGenerator
impl Default for SchemaGenerator
sourcefn default() -> SchemaGenerator
fn default() -> SchemaGenerator
Returns the “default value” for a type. Read more
sourceimpl From<SchemaSettings> for SchemaGenerator
impl From<SchemaSettings> for SchemaGenerator
sourcefn from(settings: SchemaSettings) -> Self
fn from(settings: SchemaSettings) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for SchemaGenerator
impl !Send for SchemaGenerator
impl !Sync for SchemaGenerator
impl Unpin for SchemaGenerator
impl !UnwindSafe for SchemaGenerator
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more