Struct SchemaMetadata 

pub struct SchemaMetadata {
    pub description: Option<Description>,
    pub deprecated: bool,
    pub default: Option<EureDocument>,
    pub examples: Option<Vec<EureDocument>>,
}

Schema metadata (available at any nesting level via $ext-type on $types.type)

description => union { string, .text.markdown } (optional)
deprecated => .boolean (optional)
default => .any (optional)
examples => [`any`] (optional)

Note: optional and binding_style are per-field extensions stored in RecordFieldSchema

Fields

description: Option<Description>

Documentation/description

deprecated: bool

Marks as deprecated

default: Option<EureDocument>

Default value for optional fields

examples: Option<Vec<EureDocument>>

Example values as Eure documents

Trait Implementations

impl Clone for SchemaMetadata

fn clone(&self) -> SchemaMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaMetadata

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

Formats the value using the given formatter.

impl Default for SchemaMetadata

fn default() -> SchemaMetadata

Returns the “default value” for a type.

impl PartialEq for SchemaMetadata

fn eq(&self, other: &SchemaMetadata) -> 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 StructuralPartialEq for SchemaMetadata