Enum Schema 

#[non_exhaustive]
pub enum Schema {
    Array(Array),
    Object(Object),
    OneOf(OneOf),
    AllOf(AllOf),
    AnyOf(AnyOf),
}

Available on crate feature openapi and non-WebAssembly only.

Is super type for OpenAPI Schema Object. Schema is reusable resource what can be referenced from path operations and other components using Ref.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Array(Array)

Defines array schema from another schema. Typically used with Schema::Object. Slice and Vec types are translated to Schema::Array types.

Object(Object)

Defines object schema. Object is either object holding properties which are other Schemas or can be a field within the Object.

OneOf(OneOf)

Creates a OneOf type composite Object schema. This schema is used to map multiple schemas together where API endpoint could return any of them. Schema::OneOf is created form mixed enum where enum contains various variants.

AllOf(AllOf)

Creates a AllOf type composite Object schema.

AnyOf(AnyOf)

Creates a AnyOf type composite Object schema.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>( __deserializer: __D, ) -> Result<Schema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AllOf> for Schema

fn from(one_of: AllOf) -> Schema

Converts to this type from the input type.

impl From<AllOfBuilder> for Schema

fn from(builder: AllOfBuilder) -> Schema

Converts to this type from the input type.

impl From<AnyOf> for Schema

fn from(any_of: AnyOf) -> Schema

Converts to this type from the input type.

impl From<AnyOfBuilder> for Schema

fn from(builder: AnyOfBuilder) -> Schema

Converts to this type from the input type.

impl From<Array> for Schema

fn from(array: Array) -> Schema

Converts to this type from the input type.

impl From<ArrayBuilder> for Schema

fn from(builder: ArrayBuilder) -> Schema

Converts to this type from the input type.

impl From<Object> for Schema

fn from(s: Object) -> Schema

Converts to this type from the input type.

impl From<ObjectBuilder> for Schema

fn from(builder: ObjectBuilder) -> Schema

Converts to this type from the input type.

impl From<OneOf> for Schema

fn from(one_of: OneOf) -> Schema

Converts to this type from the input type.

impl From<OneOfBuilder> for Schema

fn from(builder: OneOfBuilder) -> Schema

Converts to this type from the input type.

impl From<RefOr<Schema>> for Schema

fn from(value: RefOr<Schema>) -> Schema

Converts to this type from the input type.

impl From<Schema> for AdditionalProperties<Schema>

fn from(value: Schema) -> AdditionalProperties<Schema>

Converts to this type from the input type.

impl PartialEq for Schema

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

fn string() -> Schema

Create a string schema

fn integer() -> Schema

Create an integer schema

fn number() -> Schema

Create a number (float) schema

fn boolean() -> Schema

Create a boolean schema

fn object() -> Schema

Create an empty object schema

fn date() -> Schema

Create a date schema (string with format: “date”)

fn datetime() -> Schema

Create a datetime schema (string with format: “date-time”)

fn array(items: Schema) -> Schema

Create an array schema with the given item schema

fn object_with_properties( properties: Vec<(impl Into<String>, Schema)>, required: Vec<impl Into<String>>, ) -> Schema

Create an object schema with properties and required fields

fn object_with_description( properties: Vec<(impl Into<String>, Schema)>, required: Vec<impl Into<String>>, description: impl Into<String>, ) -> Schema

Create an object schema with properties, required fields, and description

impl Serialize for Schema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Schema