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

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).

Object(SchemaObject)

A JSON Schema object.

Implementations

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.

Returns true if self is a $ref schema.

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

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

The name of the generated JSON Schema. Read more

Generates a JSON Schema for this type. Read more

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

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

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.