Struct schemars::visit::SetSingleExample
source · [−]pub struct SetSingleExample {
pub retain_examples: bool,
}
Expand description
This visitor will remove the examples
schema property and (if present) set its first value as the example
property.
This is useful for dialects of JSON Schema (e.g. OpenAPI 3.0) that do not support the examples
property.
Fields
retain_examples: bool
When set to true
, the examples
property will not be removed, but its first value will still be copied to example
.
Trait Implementations
sourceimpl Clone for SetSingleExample
impl Clone for SetSingleExample
sourcefn clone(&self) -> SetSingleExample
fn clone(&self) -> SetSingleExample
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 SetSingleExample
impl Debug for SetSingleExample
sourceimpl Visitor for SetSingleExample
impl Visitor for SetSingleExample
sourcefn visit_schema_object(&mut self, schema: &mut SchemaObject)
fn visit_schema_object(&mut self, schema: &mut SchemaObject)
Override this method to modify a SchemaObject
and (optionally) its subschemas. Read more
sourcefn visit_root_schema(&mut self, root: &mut RootSchema)
fn visit_root_schema(&mut self, root: &mut RootSchema)
Override this method to modify a RootSchema
and (optionally) its subschemas. Read more
sourcefn visit_schema(&mut self, schema: &mut Schema)
fn visit_schema(&mut self, schema: &mut Schema)
Auto Trait Implementations
impl RefUnwindSafe for SetSingleExample
impl Send for SetSingleExample
impl Sync for SetSingleExample
impl Unpin for SetSingleExample
impl UnwindSafe for SetSingleExample
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