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§

source§

impl Clone for SetSingleExample

source§

fn clone(&self) -> SetSingleExample

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SetSingleExample

source§

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

Formats the value using the given formatter. Read more
source§

impl Visitor for SetSingleExample

source§

fn visit_schema_object(&mut self, schema: &mut SchemaObject)

Override this method to modify a SchemaObject and (optionally) its subschemas. Read more
source§

fn visit_root_schema(&mut self, root: &mut RootSchema)

Override this method to modify a RootSchema and (optionally) its subschemas. Read more
source§

fn visit_schema(&mut self, schema: &mut Schema)

Override this method to modify a Schema and (optionally) its subschemas. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> GenVisitor for T
where T: Visitor + Debug + Clone + Any,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Upcasts this visitor into an Any, which can be used to inspect and manipulate it as its concrete type.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.