Struct jsl::schema::Schema

pub struct Schema { /* fields omitted */ }

An abstract representation of a JSL schema.

This struct is meant for use by validators, code generators, or other high-level processors of schemas. For serialization and deserialization of schemas, instead use Serde.

Methods

impl Schema

pub fn from_parts(
    defs: Option<HashMap<String, Schema>>,
    form: Box<Form>,
    extra: HashMap<String, Value>
) -> Schema

Construct a new schema from its constituent parts.

defs should be present (i.e. not None) if and only if the constructed schema is a root one. This invariant is not enforced, but many users of this crate will presume that root schemas have definitions they can unwrap. Likewise, some tooling will assume that any schema which has non-None definitions are root schemas.

pub fn from_serde(serde_schema: Serde) -> Result<Self, Error>

Construct a new, root schema from a Serde.

pub fn into_serde(self) -> Serde

Convert this schema into a Serde.

pub fn is_root(&self) -> bool

Is this schema a root schema?

Under the hood, this is entirely equivalent to checking whether definitions().is_some().

pub fn definitions(&self) -> &Option<HashMap<String, Schema>>

Get the definitions associated with this schema.

If this schema is non-root, this returns None.

pub fn form(&self) -> &Form

Get the form of the schema.

pub fn extra(&self) -> &HashMap<String, Value>

Get extra data associated with this schema.

Essentially, this function returns a JSON object of properties that aren't JSL keywords, but which were included in the schema's JSON. You might use these nonstandard fields to implement custom behavior.

Trait Implementations

impl PartialEq<Schema> for Schema

fn eq(&self, other: &Schema) -> bool

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

fn ne(&self, other: &Schema) -> bool

This method tests for !=.

impl Clone for Schema

fn clone(&self) -> Schema

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