Struct Node 

pub struct Node<D, P, C> {
    pub idx: NodeIdx,
    pub parents: Vec<(NodeIdx, P)>,
    pub children: Vec<(NodeIdx, C)>,
    pub data: D,
}

Fields

idx: NodeIdx

parents: Vec<(NodeIdx, P)>

children: Vec<(NodeIdx, C)>

data: D

Implementations

impl<D, P, C> Node<D, P, C>

pub fn new(idx: NodeIdx, data: D) -> Self

pub fn parents(&self) -> impl DoubleEndedIterator<Item = (NodeIdx, &P)> + '_

pub fn parent_idxs(&self) -> impl DoubleEndedIterator<Item = NodeIdx> + '_

pub fn parent_idx(&self) -> Result<NodeIdx>

Assuming self has exactly one parent node, return it. Return an error if the assumption is violated.

pub fn parent_edges( &self, ) -> impl DoubleEndedIterator<Item = Edge<NodeIdx, &P>> + '_

pub fn parent_edges_mut( &mut self, ) -> impl DoubleEndedIterator<Item = Edge<NodeIdx, &mut P>> + '_

pub fn count_parents(&self) -> usize

pub fn has_parents(&self) -> bool

pub fn add_parent(&mut self, pidx: NodeIdx, pdata: P)

pub fn insert_parent(&mut self, pidx: NodeIdx, pdata: P, pos: usize)

Insert (pidx, pdata) as the pos-th parent of self.

pub fn remove_parent(&mut self, parent_idx: NodeIdx) -> Result<P>

Filter out parent_idx from self.parents. Return an error if self.parents does not contain parent_idx.

pub fn children(&self) -> impl DoubleEndedIterator<Item = (NodeIdx, &C)> + '_

pub fn child_idxs(&self) -> impl DoubleEndedIterator<Item = NodeIdx> + '_

pub fn first_child_idx(&self) -> Option<NodeIdx>

pub fn last_child_idx(&self) -> Option<NodeIdx>

pub fn nth_child_idx(&self, n: usize) -> Option<NodeIdx>

pub fn child_edges( &self, ) -> impl DoubleEndedIterator<Item = Edge<NodeIdx, &C>> + '_

pub fn count_children(&self) -> usize

pub fn has_children(&self) -> bool

pub fn add_child(&mut self, cidx: NodeIdx, cdata: C)

pub fn insert_child(&mut self, cidx: NodeIdx, cdata: C, pos: usize)

Insert child_idx as the pos-th child of self.

pub fn remove_child(&mut self, child_idx: NodeIdx) -> Result<C>

Filter out child_idx from self.children. Return an error if self.children does not contain child_idx.

pub fn get_parent_ordinal(&self, parent_idx: NodeIdx) -> Option<usize>

Assuming that parent_idx is a member of self.parents, return the ordinal numeral for parent_idx e.g. the leftmost parent is the zeroth parent of self. Return None if parent_idx is not a member of self.parents.

pub fn get_child_ordinal(&self, child_idx: NodeIdx) -> Option<usize>

Assuming that child_idx is a member of self.children, return the ordinal numeral for child_idx e.g. the leftmost child is the zeroth child of self. Return None if child_idx is not a member of self.children.

pub fn is_root_node(&self) -> bool

pub fn is_branch_node(&self) -> bool

pub fn is_leaf_node(&self) -> bool

Trait Implementations

impl<D: Clone, P: Clone, C: Clone> Clone for Node<D, P, C>

fn clone(&self) -> Node<D, P, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug, P: Debug, C: Debug> Debug for Node<D, P, C>

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

Formats the value using the given formatter.

impl<D, P, C> Deref for Node<D, P, C>

type Target = D

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<D, P, C> DerefMut for Node<D, P, C>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, D, P, C> Deserialize<'de> for Node<D, P, C>

where D: Deserialize<'de>, P: Deserialize<'de>, C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: Hash, P: Hash, C: Hash> Hash for Node<D, P, C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<D: Ord, P: Ord, C: Ord> Ord for Node<D, P, C>

fn cmp(&self, other: &Node<D, P, C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<D: PartialEq, P: PartialEq, C: PartialEq> PartialEq for Node<D, P, C>

fn eq(&self, other: &Node<D, P, C>) -> 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<D: PartialOrd, P: PartialOrd, C: PartialOrd> PartialOrd for Node<D, P, C>

fn partial_cmp(&self, other: &Node<D, P, C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<D, P, C> Serialize for Node<D, P, C>

where D: Serialize, P: Serialize, C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<D: Eq, P: Eq, C: Eq> Eq for Node<D, P, C>

impl<D, P, C> StructuralPartialEq for Node<D, P, C>