Struct ObjectSchema 

pub struct ObjectSchema {

    pub all_of: Vec<ObjectOrReference<ObjectSchema>>,
    pub any_of: Vec<ObjectOrReference<ObjectSchema>>,
    pub one_of: Vec<ObjectOrReference<ObjectSchema>>,
    pub items: Option<Box<Schema>>,
    pub properties: BTreeMap<String, ObjectOrReference<ObjectSchema>>,
    pub additional_properties: Option<AdditionalProperties>,
    pub schema_type: Option<String>,
    pub enum_values: Vec<Value>,
    pub multiple_of: Option<Number>,
    pub maximum: Option<Number>,
    pub exclusive_maximum: Option<Number>,
    pub minimum: Option<Number>,
    pub exclusive_minimum: Option<Number>,
    pub max_length: Option<u64>,
    pub min_length: Option<u64>,
    pub pattern: Option<String>,
    pub max_items: Option<u64>,
    pub min_items: Option<u64>,
    pub unique_items: Option<bool>,
    pub max_properties: Option<u64>,
    pub min_properties: Option<u64>,
    pub required: Vec<String>,
    pub format: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub deprecated: Option<bool>,
    pub nullable: Option<bool>,
    pub read_only: Option<bool>,
    pub write_only: Option<bool>,
    pub discriminator: Option<Discriminator>,
    pub example: Option<Value>,
    pub extensions: BTreeMap<String, Value>,
}

A schema object allows the definition of input and output data types. OAS 3.0 uses a single type string and optional nullable boolean.

Fields

all_of: Vec<ObjectOrReference<ObjectSchema>>

any_of: Vec<ObjectOrReference<ObjectSchema>>

one_of: Vec<ObjectOrReference<ObjectSchema>>

items: Option<Box<Schema>>

properties: BTreeMap<String, ObjectOrReference<ObjectSchema>>

additional_properties: Option<AdditionalProperties>

schema_type: Option<String>

OAS 3.0: type is a single string (e.g. “string”, “integer”, “object”).

enum_values: Vec<Value>

multiple_of: Option<Number>

maximum: Option<Number>

exclusive_maximum: Option<Number>

minimum: Option<Number>

exclusive_minimum: Option<Number>

max_length: Option<u64>

min_length: Option<u64>

pattern: Option<String>

max_items: Option<u64>

min_items: Option<u64>

unique_items: Option<bool>

max_properties: Option<u64>

min_properties: Option<u64>

required: Vec<String>

format: Option<String>

title: Option<String>

description: Option<String>

default: Option<Value>

deprecated: Option<bool>

nullable: Option<bool>

read_only: Option<bool>

write_only: Option<bool>

discriminator: Option<Discriminator>

example: Option<Value>

extensions: BTreeMap<String, Value>

Implementations

impl ObjectSchema

pub fn is_nullable(&self) -> Option<bool>

Returns true if this schema allows null (OAS 3.0: nullable: true).

Trait Implementations

impl Clone for ObjectSchema

fn clone(&self) -> ObjectSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectSchema

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

Formats the value using the given formatter.

impl Default for ObjectSchema

fn default() -> ObjectSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObjectSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromRef for ObjectSchema

fn from_ref(spec: &OpenApiV30Spec, path: &str) -> Result<Self, ErrorRef>

Finds an object in spec using the given path.

impl PartialEq for ObjectSchema

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

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 ObjectSchema