Struct schemars::schema::Metadata

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>,
}

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.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

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.

impl PartialEq for Metadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for Metadata