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 new_empty() -> Self

Construct a new, non-root, empty-form schema without any extra data.

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

Construct a new, root schema from a Serde.

pub fn is_root(&self) -> bool

Is this schema a root schema?

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

pub fn root_data(&self) -> &Option<RootData>

Get the root data associated with this schema.

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

pub fn root_data_mut(&mut self) -> &mut Option<RootData>

Same as root_data, but takes a mutable reference.

pub fn root_data_root(self) -> Option<RootData>

Same as root_data, but moves ownership.

pub fn form(&self) -> &Form

Get the form of the schema.

pub fn form_mut(&mut self) -> &mut Form

Same as form, but takes a mutable reference.

pub fn into_form(self) -> Form

Same as form, but moves ownership.

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

Get the extra data on the schema.

Extra data here refers to key-value pairs on a schema which were present on the data, but the keys were not any of the keywords in JSL.

This data is useful if you're implementing custom functionality on top of JSL.

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

Same as extra, but takes a mutable reference.

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

Same as extra, but moves ownership.

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.