Struct Schema 

pub struct Schema<T> { /* private fields */ }

A JSON Schema paired with a function that validates a JSON value and converts it into T.

The JSON Schema is produced lazily on first access and cached; cloning a schema shares the cache and the validator.

Implementations

impl<T> Schema<T>

where T: DeserializeOwned + JsonSchema + 'static,

pub fn derived() -> Schema<T>

Derives the schema from T (draft-07, additionalProperties: false on objects) and validates by deserializing into T.

pub fn derived_with(dialect: SchemaDialect) -> Schema<T>

Like Schema::derived with an explicit dialect.

impl<T> Schema<T>

where T: DeserializeOwned + 'static,

pub fn typed_from_json_schema(schema: Value) -> Schema<T>

Uses a raw JSON Schema and validates by deserializing into T.

With the json-schema-validation feature the value is first checked against the JSON Schema, so constraints that serde cannot express (ranges, patterns) are enforced as well.

impl Schema<Value>

pub fn from_json_schema(schema: Value) -> Schema<Value>

Uses a raw JSON Schema; the value is returned unchanged after validation.

With the json-schema-validation feature the value is checked against the schema (compiled lazily on first validation); without it every value passes.

pub fn empty_object() -> Schema<Value>

The empty object schema ({type: object, properties: {}, additionalProperties: false}) used when no schema is given.

pub fn any() -> Schema<Value>

A schema that accepts any JSON value.

impl<T> Schema<T>

where T: 'static,

pub fn lazy( json_schema: impl FnOnce() -> Value + Send + 'static, validate: impl Fn(Value) -> Result<T, TypeValidationError> + Send + Sync + 'static, ) -> Schema<T>

Creates a schema from a lazily generated JSON Schema and a validator.

pub fn with_json_schema_and_validator( json_schema: Value, validate: impl Fn(Value) -> Result<T, TypeValidationError> + Send + Sync + 'static, ) -> Schema<T>

Creates a schema from a JSON Schema value and a validator.

pub fn with_validator( self, validate: impl Fn(Value) -> Result<T, TypeValidationError> + Send + Sync + 'static, ) -> Schema<T>

Replaces the validator, keeping the JSON Schema.

pub fn transformed( &self, transform: SchemaTransform, ) -> Result<Schema<T>, SchemaError>

Returns a copy whose JSON Schema is rewritten by transform immediately; validation is unchanged.

Errors

Returns crate::SchemaError::UnsupportedTransform if the schema cannot be represented by the requested transform.

pub fn erased(&self) -> Schema<Value>

Returns a Schema<Value> that runs this schema’s validation but yields the original JSON value.

impl<T> Schema<T>

pub fn json_schema(&self) -> &Value

Returns the JSON Schema, generating it on first access.

pub fn validate(&self, value: Value) -> Result<T, TypeValidationError>

Validates value and converts it into T.

Errors

Returns TypeValidationError when the value does not match.

Trait Implementations

impl<T> Clone for Schema<T>

fn clone(&self) -> Schema<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Schema<T>

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

Formats the value using the given formatter.