Struct SchemaRef 

pub struct SchemaRef(/* private fields */);

A shared reference to a JSON Schema.

This wraps a serde_json::Value that represents a JSON Schema. The value should be either an object or a boolean (the valid top-level JSON Schema values).

Implementations

impl SchemaRef

pub fn for_type<T: JsonSchema>() -> Self

Create a schema reference from a type that implements JsonSchema.

pub fn parse_json(s: &str) -> Result<Self, Error>

Parse a JSON Schema from a JSON string.

pub fn as_value(&self) -> &Value

Get the schema as a JSON value reference.

Trait Implementations

impl AsRef<Value> for SchemaRef

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SchemaRef

fn clone(&self) -> SchemaRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaRef

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

Formats the value using the given formatter.

impl Default for SchemaRef

fn default() -> SchemaRef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SchemaRef> for Secrets

fn from(value: &SchemaRef) -> Self

Converts to this type from the input type.

impl From<SchemaRef> for VariableSchema

fn from(schema: SchemaRef) -> Self

Converts to this type from the input type.

impl From<Value> for SchemaRef

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<VariableSchema> for SchemaRef

fn from(var_schema: VariableSchema) -> Self

Converts to this type from the input type.

impl JsonSchema for SchemaRef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for SchemaRef

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

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 SchemaRef