Struct Property 

pub struct Property {
    pub name: String,
    pub type: TypeRef,
    pub required: bool,
    pub title: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
    pub read_only: bool,
    pub write_only: bool,
    pub external_docs: Option<ExternalDocs>,
    pub default: Option<ValueRef>,
    pub examples: Vec<(String, Example)>,
    pub extensions: Vec<(String, ValueRef)>,
}

Fields

name: String

type: TypeRef

required: bool

true when the spec lists this property name in the parent schema’s required array. Moved here from ObjectType.required for a uniform spelling with Parameter.required.

title: Option<String>

JSON Schema title — short human label.

description: Option<String>

JSON Schema / OAS description (CommonMark).

deprecated: bool

JSON Schema 2020-12 deprecated.

read_only: bool

write_only: bool

external_docs: Option<ExternalDocs>

Per-schema externalDocs (OAS Schema Object).

default: Option<ValueRef>

JSON Schema default for the property. ValueRef indexes into crate::Ir::values; compound defaults are pooled there.

examples: Vec<(String, Example)>

OAS example / examples for this property. Named entries; 3.0 example: <literal> lands under the synthetic key "_default".

extensions: Vec<(String, ValueRef)>

x-* extensions declared on the property’s schema. Each entry pairs a key with a ValueRef into crate::Ir::values; compound values are pooled there.

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Property

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Property

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

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 Property