Struct schemars::schema::Metadata

source · [−]

pub struct Metadata {
    pub id: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub deprecated: bool,
    pub read_only: bool,
    pub write_only: bool,
    pub examples: Vec<Value>,
}

Expand description

Properties which annotate a SchemaObject which typically have no effect when an object is being validated against the schema.

Fields

id: Option<String>

The $id keyword.

See JSON Schema 8.2.2. The “$id” Keyword.

title: Option<String>

The title keyword.

See JSON Schema Validation 9.1. “title” and “description”.

description: Option<String>

The description keyword.

See JSON Schema Validation 9.1. “title” and “description”.

default: Option<Value>

The default keyword.

See JSON Schema Validation 9.2. “default”.

deprecated: bool

The deprecated keyword.

See JSON Schema Validation 9.3. “deprecated”.

read_only: bool

The readOnly keyword.

See JSON Schema Validation 9.4. “readOnly” and “writeOnly”.

write_only: bool

The writeOnly keyword.

See JSON Schema Validation 9.4. “readOnly” and “writeOnly”.

examples: Vec<Value>

The examples keyword.

See JSON Schema Validation 9.5. “examples”.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

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

impl Debug for Metadata

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

Formats the value using the given formatter. Read more

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Metadata where
Metadata: Default,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<Metadata> for Metadata

fn eq(&self, other: &Metadata) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &Metadata) -> bool

This method tests for !=.

impl Serialize for Metadata

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Metadata

Auto Trait Implementations

impl RefUnwindSafe for Metadata

impl Send for Metadata

impl Sync for Metadata

impl Unpin for Metadata

impl UnwindSafe for Metadata

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,