Struct Node 

pub struct Node(/* private fields */);

A node in the document tree: an element with attributes, child content and marks, or — when is_text — a marked text run.

Positions follow the ProseMirror model. A text node’s size is its length in Unicode scalar values (chars — note this differs from ProseMirror’s UTF-16 units; the DOM bridge maps between them). A non-text leaf has size 1; any other node has size content.size + 2.

Implementations

impl Node

pub fn to_html(&self) -> String

Serialize this node (and its subtree) to an HTML string.

Text and attribute values are HTML-escaped. A node type whose spec has no to_dom is transparent — only its content is emitted (the usual case for the document node), which is why a serialized document is a run of its block children with no wrapper.

impl Node

pub fn to_json(&self) -> Value

Serialize this node (and its subtree) to JSON.

impl Node

pub fn node_type(&self) -> &NodeType

This node’s type.

pub fn attrs(&self) -> &Attrs

This node’s attributes.

pub fn content(&self) -> &Fragment

This node’s child fragment (empty for text and leaf nodes).

pub fn marks(&self) -> &[Mark]

The marks applied to this node.

pub fn text(&self) -> Option<&str>

The text of a text node, or None for element nodes.

pub fn is_text(&self) -> bool

Whether this is a text node.

pub fn is_leaf(&self) -> bool

Whether this node is a leaf (no content).

pub fn is_inline(&self) -> bool

Whether this node is inline.

pub fn is_block(&self) -> bool

Whether this node is a block.

pub fn child_count(&self) -> usize

Number of direct children.

pub fn child(&self, i: usize) -> &Node

Borrow the child at index i.

Panics

Panics if i >= child_count().

pub fn node_size(&self) -> usize

The number of positions this node occupies in its parent.

pub fn text_content(&self) -> String

The concatenated text of this node and its descendants.

pub fn with_marks(&self, marks: Vec<Mark>) -> Node

Return a copy of this node with marks as its mark set.

pub fn node_at(&self, pos: usize) -> Option<Node>

The node that begins at absolute position pos within this node’s subtree (descending into children), or None if pos does not land exactly on a node boundary.

impl Node

pub fn replace( &self, from: usize, to: usize, slice: &Slice, schema: &Schema, ) -> Result<Node, ReplaceError>

Replace the range from..to with slice, returning the new root.

The document is treated as the root. Content that would violate the schema (including illegal joins at the boundaries) is rejected with a ReplaceError rather than silently produced.

pub fn slice(&self, from: usize, to: usize) -> Result<Slice, DocError>

Extract the content between from and to as a Slice, recording how deeply each end is open so it can be re-inserted faithfully.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Eq for Node

impl PartialEq for Node

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