Struct DefaultSchema

pub struct DefaultSchema {

    pub reference: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub data_type: Option<DataType>,
    pub format: Option<DataTypeFormat>,
    pub maximum: Option<f32>,
    pub minimum: Option<f32>,
    pub example: Option<Value>,
    pub properties: BTreeMap<String, Resolvable<DefaultSchema>>,
    pub items: Option<Resolvable<DefaultSchema>>,
    pub enum_: Vec<Value>,
    pub extra_props: Option<Either<bool, Resolvable<DefaultSchema>>>,
    pub required: BTreeSet<String>,
    /* private fields */
}

Default schema if your schema doesn’t have any custom fields.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schemaObject

Fields

reference: Option<String>

title: Option<String>

description: Option<String>

data_type: Option<DataType>

format: Option<DataTypeFormat>

maximum: Option<f32>

minimum: Option<f32>

example: Option<Value>

properties: BTreeMap<String, Resolvable<DefaultSchema>>

items: Option<Resolvable<DefaultSchema>>

enum_: Vec<Value>

extra_props: Option<Either<bool, Resolvable<DefaultSchema>>>

required: BTreeSet<String>

Trait Implementations

impl Clone for DefaultSchema

fn clone(&self) -> DefaultSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultSchema

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

Formats the value using the given formatter.

impl Default for DefaultSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DefaultSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Schema for DefaultSchema

fn name(&self) -> Option<&str>

Name of this schema, if any.

fn set_name(&mut self, name: &str)

Sets the name for this schema. This is done by the resolver.

fn set_cyclic(&mut self, cyclic: bool)

Set whether this definition is cyclic. This is done by the resolver.

fn is_cyclic(&self) -> bool

Returns whether this definition is cyclic.

fn description(&self) -> Option<&str>

Description for this schema, if any (description field).

fn reference(&self) -> Option<&str>

Reference to some other schema, if any ($ref field).

fn set_reference(&mut self, ref_: String)

Set the reference to this schema.

fn data_type(&self) -> Option<DataType>

Data type of this schema, if any (type field).

fn format(&self) -> Option<&DataTypeFormat>

Data type format used by this schema, if any (format field).

fn items(&self) -> Option<&Resolvable<Self>>

Schema for array definitions, if any (items field).

fn items_mut(&mut self) -> Option<&mut Resolvable<Self>>

Mutable access to the items field, if it exists.

fn additional_properties(&self) -> Option<&Either<bool, Resolvable<Self>>>

Value schema for maps (additional_properties field).

fn additional_properties_mut( &mut self, ) -> Option<&mut Either<bool, Resolvable<Self>>>

Mutable access to additional_properties field, if it’s a map.

fn properties(&self) -> Option<&BTreeMap<String, Resolvable<Self>>>

Map of names and schema for properties, if it’s an object (properties field)

fn properties_mut(&mut self) -> Option<&mut BTreeMap<String, Resolvable<Self>>>

Mutable access to properties field.

fn required_properties(&self) -> Option<&BTreeSet<String>>

Returns the required properties (if any) for this object.

fn enum_variants(&self) -> Option<&[Value]>

Enum variants in this schema (if any). It’s serde_json::Value because:

fn contains_any(&self) -> bool

Returns whether this definition “is” or “has” Any type.

impl Serialize for DefaultSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.