Struct Schema 

pub struct Schema { /* private fields */ }

A compiled spec.

Implementations

impl Schema

pub fn standard(&self) -> StandardSchema<'_>

The Standard Schema V1 surface of this schema.

impl Schema

pub fn new(spec: impl Into<Spec>) -> Schema

pub fn with_options(spec: impl Into<Spec>, opts: &Options) -> Schema

Compile a spec, reading it as the options say.

pub fn parse(src: &str) -> Result<Schema, ExprError>

Compile the string form of a spec: Schema::parse("String.Min(2)").

pub fn json(&self) -> Result<Value, JsonError>

The schema as a JSON Schema document (draft 2020-12). The declarative JSON of the shape, which crate::expr::build reads back.

pub fn json_schema(&self) -> Value

pub fn defs(&self) -> &HashMap<String, Arc<Node>>

The defined nodes of the schema, by name.

pub fn node(&self) -> &Node

The compiled tree.

pub fn validate(&self, input: Value) -> Result<Value, ValidationError>

Validate and complete a value: defaults injected, children validated. Value::Undefined is no value at all, as a bare shape() call is.

pub fn validate_ctx( &self, input: Value, ctx: &mut Context, ) -> Result<Value, ValidationError>

validate with a context of the caller’s, for custom validators.

pub fn valid(&self, input: &Value) -> bool

Whether the value validates. Nothing is produced or rendered.

pub fn matches(&self, input: &Value) -> bool

valid by another name.

pub fn error(&self, input: &Value) -> Vec<FieldError>

The errors of validating the value; empty when it validates.

impl Schema

pub fn validate_into<T: DeserializeOwned>( &self, input: impl Into<Value>, ) -> Result<T, IntoError>

Validate, and deserialize the produced value into a type.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate 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.