Enum schemars::schema::Schema

pub enum Schema {
    Bool(bool),
    Object(SchemaObject),
}

A JSON Schema.

Variants

Bool(bool)

A trivial boolean JSON Schema.

The schema true matches everything (always passes validation), whereas the schema false matches nothing (always fails validation).

Tuple Fields of Bool

0: bool

Object(SchemaObject)

A JSON Schema object.

Tuple Fields of Object

0: SchemaObject

Implementations

impl Schema

pub fn new_ref(reference: String) -> Self

Creates a new $ref schema.

The given reference string should be a URI reference. This will usually be a JSON Pointer in URI Fragment representation.

pub fn is_ref(&self) -> bool

Returns true if self is a $ref schema.

If self is a SchemaObject with Some reference set, this returns true. Otherwise, returns false.

pub fn into_object(self) -> SchemaObject

Converts the given schema (if it is a boolean schema) into an equivalent schema object.

If the given schema is already a schema object, this has no effect.

Example

use schemars::schema::{Schema, SchemaObject};

let bool_schema = Schema::Bool(true);

assert_eq!(bool_schema.into_object(), SchemaObject::default());

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl From<Schema> for SchemaObject

fn from(schema: Schema) -> Self

Performs the conversion.

impl From<SchemaObject> for Schema

fn from(o: SchemaObject) -> Self

Performs the conversion.

impl From<bool> for Schema

fn from(b: bool) -> Self

Performs the conversion.

impl JsonSchema for Schema

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Schema> for Schema

fn eq(&self, other: &Schema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Schema) -> bool

This method tests for !=.

impl Serialize for Schema

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 Schema