Struct Schema 

pub struct Schema {
    pub nodes: HashMap<String, NodeSpec>,
    pub marks: HashMap<String, MarkSpec>,
}

An allow-list schema: which node/mark types, attributes, and children are permitted. Build with Schema::new or load with Schema::from_json_str.

Fields

nodes: HashMap<String, NodeSpec>

Node type -> its spec. Types absent here are reported as unknown.

marks: HashMap<String, MarkSpec>

Mark type -> its spec. Marks absent here are reported as unknown.

Implementations

impl Schema

pub fn new() -> Self

An empty schema.

pub fn node(self, node_type: impl Into<String>, spec: NodeSpec) -> Self

Register (or replace) a node type’s spec.

pub fn mark(self, mark_type: impl Into<String>, spec: MarkSpec) -> Self

Register (or replace) a mark type’s spec.

pub fn from_json_str(s: &str) -> Result<Self>

Load a schema from its JSON definition.

use tiptap_rusty_parser::Schema;
let schema = Schema::from_json_str(r#"{
  "nodes": { "doc": { "content": ["paragraph"] }, "paragraph": { "content": ["text"] }, "text": {} },
  "marks": { "link": { "attrs": ["href"], "required_attrs": ["href"] } }
}"#).unwrap();
assert!(schema.nodes.contains_key("doc"));

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.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

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

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 Schema