Struct ego_tree::NodeRef

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

Node reference.

Methods

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

Important traits for Ancestors<'a, T>

impl<'a, T: 'a> Iterator for Ancestors<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over ancestors.

Important traits for PrevSiblings<'a, T>

impl<'a, T: 'a> Iterator for PrevSiblings<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over previous siblings.

Important traits for NextSiblings<'a, T>

impl<'a, T: 'a> Iterator for NextSiblings<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over next siblings.

Important traits for FirstChildren<'a, T>

impl<'a, T: 'a> Iterator for FirstChildren<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over first children.

Important traits for LastChildren<'a, T>

impl<'a, T: 'a> Iterator for LastChildren<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over last children.

Important traits for Children<'a, T>

impl<'a, T: 'a> Iterator for Children<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over children.

Important traits for Traverse<'a, T>

impl<'a, T: 'a> Iterator for Traverse<'a, T> type Item = Edge<'a, T>;

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

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

Important traits for Descendants<'a, T>

impl<'a, T: 'a> Iterator for Descendants<'a, T> type Item = NodeRef<'a, T>;

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

Returns an iterator over this node and its descendants.

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

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<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.

Trait Implementations

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

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

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

Performs the conversion.

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

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

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

Formats the value using the given formatter.