Struct oxymcts::NodeRef

pub struct NodeRef<'a, T> where
    T: 'a,  { /* fields omitted */ }

Node reference.

Implementations

impl<'a, T> NodeRef<'a, T> where
    T: 'a, 

pub fn id(&self) -> NodeId

Returns the ID of this node.

pub fn tree(&self) -> &'a Tree<T>

Returns the tree owning this node.

pub fn value(&self) -> &'a T

Returns the value of this node.

pub fn parent(&self) -> Option<NodeRef<'a, T>>

Returns the parent of this node.

pub fn prev_sibling(&self) -> Option<NodeRef<'a, T>>

Returns the previous sibling of this node.

pub fn next_sibling(&self) -> Option<NodeRef<'a, T>>

Returns the next sibling of this node.

pub fn first_child(&self) -> Option<NodeRef<'a, T>>

Returns the first child of this node.

pub fn last_child(&self) -> Option<NodeRef<'a, T>>

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.

impl<'a, T> NodeRef<'a, T> where
    T: 'a, 

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

Returns an iterator over ancestors.

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

Returns an iterator over previous siblings.

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

Returns an iterator over next siblings.

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

Returns an iterator over first children.

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

Returns an iterator over last children.

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

Returns an iterator over children.

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

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

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

Returns an iterator over this node and its descendants.

Trait Implementations

impl<'a, T> Clone for NodeRef<'a, T> where
    T: 'a, 

fn clone(&self) -> NodeRef<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Copy for NodeRef<'a, T> where
    T: 'a, 

impl<'a, T> Debug for NodeRef<'a, T> where
    T: 'a + Debug, 

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

Formats the value using the given formatter.

impl<'a, T> Eq for NodeRef<'a, T> where
    T: 'a, 

impl<'a, T> From<NodeMut<'a, T>> for NodeRef<'a, T> where
    T: 'a, 

fn from(node: NodeMut<'a, T>) -> NodeRef<'a, T>

Performs the conversion.

impl<'a, T> PartialEq<NodeRef<'a, T>> for NodeRef<'a, T> where
    T: 'a, 

fn eq(&self, other: &NodeRef<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.