Struct schemars::schema::SchemaObject

pub struct SchemaObject {
    pub metadata: Option<Box<Metadata>>,
    pub instance_type: Option<SingleOrVec<InstanceType>>,
    pub format: Option<String>,
    pub enum_values: Option<Vec<Value>>,
    pub const_value: Option<Value>,
    pub subschemas: Option<Box<SubschemaValidation>>,
    pub number: Option<Box<NumberValidation>>,
    pub string: Option<Box<StringValidation>>,
    pub array: Option<Box<ArrayValidation>>,
    pub object: Option<Box<ObjectValidation>>,
    pub reference: Option<String>,
    pub extensions: Map<String, Value>,
}

A JSON Schema object.

Fields

metadata: Option<Box<Metadata>>

Properties which annotate the SchemaObject which typically have no effect when an object is being validated against the schema.

instance_type: Option<SingleOrVec<InstanceType>>

The type keyword.

See JSON Schema Validation 6.1.1. “type” and JSON Schema 4.2.1. Instance Data Model.

format: Option<String>

The format keyword.

See JSON Schema Validation 7. A Vocabulary for Semantic Content With “format”.

enum_values: Option<Vec<Value>>

The enum keyword.

See JSON Schema Validation 6.1.2. “enum”

const_value: Option<Value>

The const keyword.

See JSON Schema Validation 6.1.3. “const”

subschemas: Option<Box<SubschemaValidation>>

Properties of the SchemaObject which define validation assertions in terms of other schemas.

number: Option<Box<NumberValidation>>

Properties of the SchemaObject which define validation assertions for numbers.

string: Option<Box<StringValidation>>

Properties of the SchemaObject which define validation assertions for strings.

array: Option<Box<ArrayValidation>>

Properties of the SchemaObject which define validation assertions for arrays.

object: Option<Box<ObjectValidation>>

Properties of the SchemaObject which define validation assertions for objects.

reference: Option<String>

The $ref keyword.

See JSON Schema 8.2.4.1. Direct References with “$ref”.

extensions: Map<String, Value>

Arbitrary extra properties which are not part of the JSON Schema specification, or which schemars does not support.

Implementations

impl SchemaObject

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 has Some reference set, this returns true. Otherwise, returns false.

pub fn has_type(&self, ty: InstanceType) -> bool

Returns true if self accepts values of the given type, according to the [instance_type] field.

This is a basic check that always returns true if no instance_type is specified on the schema, and does not check any subschemas. Because of this, both {} and {"not": {}} accept any type according to this method.

pub fn metadata(&mut self) -> &mut Metadata

Returns a mutable reference to this schema’s Metadata, creating it if it was None.

pub fn subschemas(&mut self) -> &mut SubschemaValidation

Returns a mutable reference to this schema’s SubschemaValidation, creating it if it was None.

pub fn number(&mut self) -> &mut NumberValidation

Returns a mutable reference to this schema’s NumberValidation, creating it if it was None.

pub fn string(&mut self) -> &mut StringValidation

Returns a mutable reference to this schema’s StringValidation, creating it if it was None.

pub fn array(&mut self) -> &mut ArrayValidation

Returns a mutable reference to this schema’s ArrayValidation, creating it if it was None.

pub fn object(&mut self) -> &mut ObjectValidation

Returns a mutable reference to this schema’s ObjectValidation, creating it if it was None.

Trait Implementations

impl Clone for SchemaObject

fn clone(&self) -> SchemaObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaObject

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

Formats the value using the given formatter.

impl Default for SchemaObject

fn default() -> SchemaObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaObject

where SchemaObject: Default,

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

Converts to this type from the input type.

impl From<SchemaObject> for Schema

fn from(o: SchemaObject) -> Self

Converts to this type from the input type.

impl PartialEq for SchemaObject

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

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 SchemaObject