Struct NodeSpec 

pub struct NodeSpec {
    pub content: Option<ContentRule>,
    pub group: Option<String>,
    pub marks: Option<HashSet<String>>,
    pub attrs: Option<HashSet<String>>,
    pub required_attrs: HashSet<String>,
}

Rules for one node type.

Fields

content: Option<ContentRule>

Allowed content: a set of child types (array form) or a content expression (string form). None = any child allowed.

group: Option<String>

Groups this node belongs to (space-separated, ProseMirror-style), so content expressions can reference it by group name (e.g. block).

marks: Option<HashSet<String>>

Allowed mark types on this node. None = any mark allowed.

attrs: Option<HashSet<String>>

Allowed attribute keys. None = any attrs allowed.

required_attrs: HashSet<String>

Attribute keys that must be present.

Implementations

impl NodeSpec

pub fn new() -> Self

An unrestricted node spec (any attrs/marks/children allowed).

pub fn content<I, S>(self, types: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Restrict allowed child node types (any count/order). For ordering and cardinality use content_match.

pub fn content_match(self, expr: &str) -> Self

Restrict content with a ProseMirror content expression (e.g. "heading paragraph+"). Panics on an invalid expression — use try_content_match to handle the error.

pub fn try_content_match(self, expr: &str) -> Result<Self, ParseExprError>

Fallible content_match.

pub fn group(self, group: impl Into<String>) -> Self

Set the groups this node belongs to (space-separated, e.g. "block").

pub fn content_types(&self) -> Option<&HashSet<String>>

The allowed child-type set, if content is the array form (not an expression). Convenience accessor for the content field.

pub fn marks<I, S>(self, types: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Restrict allowed mark types on this node.

pub fn attrs<I, S>(self, keys: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Restrict allowed attribute keys.

pub fn required_attrs<I, S>(self, keys: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set attribute keys that must be present.

Trait Implementations

impl Clone for NodeSpec

fn clone(&self) -> NodeSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeSpec

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

Formats the value using the given formatter.

impl Default for NodeSpec

fn default() -> NodeSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodeSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NodeSpec

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

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 NodeSpec