Struct NodeRef

pub struct NodeRef<T> { /* private fields */ }

Node reference.

Implementations

impl<T> NodeRef<T>

pub fn ancestors(&self) -> Ancestors<T>

Returns an iterator over ancestors.

pub fn prev_siblings(&self) -> PrevSiblings<T>

Returns an iterator over previous siblings.

pub fn next_siblings(&self) -> NextSiblings<T>

Returns an iterator over next siblings.

pub fn first_children(&self) -> FirstChildren<T>

Returns an iterator over first children.

pub fn last_children(&self) -> LastChildren<T>

Returns an iterator over last children.

pub fn children(&self) -> Children<T>

Returns an iterator over children.

pub fn traverse(&self) -> Traverse<T>

Returns an iterator which traverses the subtree starting at this node.

pub fn descendants(&self) -> Descendants<T>

Returns an iterator over this node and its descendants.

impl<T> NodeRef<T>

pub fn id(&self) -> NodeId

Returns the ID of this node.

pub fn map_value<F, R>(&self, map_fn: F) -> Option<R>

where F: FnOnce(&T) -> R,

Returns the result of map_fn applied to the value of this node.

pub fn update_value<F>(&self, update_fn: F) -> bool

where F: FnOnce(&mut T),

Update the value of this node.

pub fn parent(&self) -> Option<Self>

Returns the parent of this node.

pub fn prev_sibling(&self) -> Option<Self>

Returns the previous sibling of this node.

pub fn next_sibling(&self) -> Option<Self>

Returns the next sibling of this node.

pub fn first_child(&self) -> Option<Self>

Returns the first child of this node.

pub fn last_child(&self) -> Option<Self>

Returns the last child of this node.

pub fn has_siblings(&self) -> bool

Returns true if this node has siblings.

pub fn has_children(&self) -> bool

Returns true if this node has children.

pub fn detach(&mut self)

Detaches this node from its parent.

pub fn append(&mut self, value: T) -> Option<NodeRef<T>>

Appends a new child to this node.

pub fn append_id(&mut self, new_child_id: NodeId) -> Option<NodeRef<T>>

Appends a child to this node.

pub fn prepend(&mut self, value: T) -> Option<NodeRef<T>>

Prepends a new child to this node.

pub fn insert_before(&mut self, value: T) -> Option<NodeRef<T>>

Inserts a new sibling before this node.

pub fn insert_id_before(&mut self, new_sibling_id: NodeId) -> Option<NodeRef<T>>

Inserts a sibling before this node.

pub fn insert_after(&mut self, value: T) -> Option<NodeRef<T>>

Inserts a new sibling after this node.

pub fn insert_id_after(&mut self, new_sibling_id: NodeId) -> Option<NodeRef<T>>

Inserts a sibling after this node.

pub fn reparent_from_id_append(&mut self, from_id: NodeId)

Reparents the children of a node, appending them to this node.

Trait Implementations

impl<T> Clone for NodeRef<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NodeRef<T>

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

Formats the value using the given formatter.

impl<T> PartialEq for NodeRef<T>

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.