Struct NodeRef 

pub struct NodeRef { /* private fields */ }

Represents a referene to a node in the document.

Implementations

impl NodeRef

pub const fn new(cell: usize, id: usize) -> Self

Creates a new NodeRef with the given index and id.

impl NodeRef

pub fn append_child(self, arena: &mut Arena, child_ref: NodeRef)

Appends a child node to this node.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_append_child( self, arena: &mut Arena, child_ref: NodeRef, ) -> Result<()>

Appends a child node to this node.

pub fn replace_child( self, arena: &mut Arena, target_ref: NodeRef, replacer_ref: NodeRef, )

Replace a child node with another node. Replaced child will be hard removed.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_replace_child( self, arena: &mut Arena, target_ref: NodeRef, replacer_ref: NodeRef, ) -> Result<()>

Replace a child node with another node. Replaced child will be hard removed.

pub fn insert_before( self, arena: &mut Arena, target_ref: NodeRef, insertee_ref: NodeRef, )

Inserts a child node before a target node.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_insert_before( self, arena: &mut Arena, target_ref: NodeRef, insertee_ref: NodeRef, ) -> Result<()>

Inserts a child node before a target node.

pub fn insert_after( self, arena: &mut Arena, target_ref: NodeRef, insertee_ref: NodeRef, )

Inserts a child node after a target node.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_insert_after( self, arena: &mut Arena, target_ref: NodeRef, insertee_ref: NodeRef, ) -> Result<()>

Inserts a child node after a target node.

pub fn remove(self, arena: &mut Arena)

Removes this node from the document. This does not remove its children. This does not remove the node from Arena.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_remove(self, arena: &mut Arena) -> Result<()>

Removes this node from the document. This does not remove its children. This does not remove the node from Arena.

pub fn delete(self, arena: &mut Arena)

Deletes this node from the document, including all its children. This removes the node from Arena.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_delete(self, arena: &mut Arena) -> Result<()>

Removes this node from the document, including all its children. This removes the node from Arena.

pub fn merge_or_append_text(self, arena: &mut Arena, index: Index)

pub fn try_merge_or_append_text( self, arena: &mut Arena, index: Index, ) -> Result<()>

pub fn merge_or_insert_after_text( self, arena: &mut Arena, target_ref: NodeRef, index: Index, )

Merges a given index into the text node after the target node if it can be merged, otherwise creates a new Text node and inserts it after the target node.

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_merge_or_insert_after_text( self, arena: &mut Arena, target_ref: NodeRef, index: Index, ) -> Result<()>

Merges a given index into the text node after the target node if it can be merged, otherwise creates a new Text node and inserts it after the target node.

pub fn merge_or_insert_before_text( self, arena: &mut Arena, target_ref: NodeRef, index: Index, )

Merges a given index into the text node before the target node if it can be merged, otherwise creates a new Text node and inserts it before the target node.

Panics

Panics if the operation fails(e.g. due to invalid NodeRef).

pub fn try_merge_or_insert_before_text( self, arena: &mut Arena, target_ref: NodeRef, index: Index, ) -> Result<()>

Merges a given index into the text node before the target node if it can be merged, otherwise creates a new Text node and inserts it before the target node.

Trait Implementations

impl Clone for NodeRef

fn clone(&self) -> NodeRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeRef

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

Formats the value using the given formatter.

impl Default for NodeRef

fn default() -> NodeRef

Returns the “default value” for a type.

impl Display for NodeRef

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

Formats the value using the given formatter.

impl Index<NodeRef> for Arena

Implements indexing for Arena to access nodes by NodeRef. This panics if the NodeRef is invalid.

type Output = Node

The returned type after indexing.

fn index(&self, node_ref: NodeRef) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<NodeRef> for Arena

Implements mutable indexing for Arena to access nodes by NodeRef. This panics if the NodeRef is invalid.

fn index_mut(&mut self, node_ref: NodeRef) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for NodeRef

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.

impl Copy for NodeRef

impl Eq for NodeRef