Struct schemars::gen::SchemaSettings
source · [−]pub struct SchemaSettings {
pub option_nullable: bool,
pub option_add_null_type: bool,
pub definitions_path: String,
pub meta_schema: Option<String>,
pub visitors: Vec<Box<dyn GenVisitor>>,
pub inline_subschemas: bool,
/* private fields */
}
Expand description
Settings to customize how Schemas are generated.
The default settings currently conform to JSON Schema Draft 7, but this is liable to change in a future version of Schemars if support for other JSON Schema versions is added.
If you require your generated schemas to conform to draft 7, consider using the draft07
method.
Fields
option_nullable: bool
If true
, schemas for Option<T>
will include a nullable
property.
This is not part of the JSON Schema spec, but is used in Swagger/OpenAPI schemas.
Defaults to false
.
option_add_null_type: bool
definitions_path: String
A JSON pointer to the expected location of referenceable subschemas within the resulting root schema.
Defaults to "#/definitions/"
.
meta_schema: Option<String>
The URI of the meta-schema describing the structure of the generated schemas.
Defaults to "http://json-schema.org/draft-07/schema#"
.
visitors: Vec<Box<dyn GenVisitor>>
A list of visitors that get applied to all generated root schemas.
inline_subschemas: bool
Inline all subschemas instead of using references.
Some references may still be generated in schemas for recursive types.
Defaults to false
.
Implementations
sourceimpl SchemaSettings
impl SchemaSettings
sourcepub fn draft07() -> SchemaSettings
pub fn draft07() -> SchemaSettings
Creates SchemaSettings
that conform to JSON Schema Draft 7.
sourcepub fn draft2019_09() -> SchemaSettings
pub fn draft2019_09() -> SchemaSettings
Creates SchemaSettings
that conform to JSON Schema 2019-09.
sourcepub fn openapi3() -> SchemaSettings
pub fn openapi3() -> SchemaSettings
Creates SchemaSettings
that conform to OpenAPI 3.0.
sourcepub fn with(self, configure_fn: impl FnOnce(&mut Self)) -> Self
pub fn with(self, configure_fn: impl FnOnce(&mut Self)) -> Self
Modifies the SchemaSettings
by calling the given function.
Example
use schemars::gen::{SchemaGenerator, SchemaSettings};
let settings = SchemaSettings::default().with(|s| {
s.option_nullable = true;
s.option_add_null_type = false;
});
let gen = settings.into_generator();
sourcepub fn with_visitor(
self,
visitor: impl Visitor + Debug + Clone + 'static
) -> Self
pub fn with_visitor(
self,
visitor: impl Visitor + Debug + Clone + 'static
) -> Self
Appends the given visitor to the list of visitors for these SchemaSettings
.
sourcepub fn into_generator(self) -> SchemaGenerator
pub fn into_generator(self) -> SchemaGenerator
Creates a new SchemaGenerator
using these settings.
Trait Implementations
sourceimpl Clone for SchemaSettings
impl Clone for SchemaSettings
sourcefn clone(&self) -> SchemaSettings
fn clone(&self) -> SchemaSettings
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SchemaSettings
impl Debug for SchemaSettings
sourceimpl Default for SchemaSettings
impl Default for SchemaSettings
sourcefn default() -> SchemaSettings
fn default() -> SchemaSettings
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 SchemaSettings
impl !Send for SchemaSettings
impl !Sync for SchemaSettings
impl Unpin for SchemaSettings
impl !UnwindSafe for SchemaSettings
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