Struct UnifiedNode

pub struct UnifiedNode<Data: Debug> { /* private fields */ }

Available on crate feature unified only.

A node that is not split into separate branch and leaf nodes. This is the non-deque version, where children are represented as a linked list. In this version, a node’s previous sibling(s) and next sibling(s) are available, but nodes cannot be directly indexed, nor can children be detached, removed, or inserted by index.

Data represents the custom data associated with the the node.

See also

For the deque version, see UnifiedNodeDeque.

For a node that is split into separate branch and leaf nodes, see SplitNode and SplitNodeDeque.

Trait Implementations

impl<Data: Debug> BaseNode for UnifiedNode<Data>

type Representation = UnifiedNodeRepresentation<Data>

The representation of the node after it is removed from the arena.

type Branch = UnifiedNode<Data>

The type used for branch nodes.

type Leaf = UnifiedNode<Data>

The type used for leaf nodes.

fn into_representation(self, arena: &mut Arena<Self>) -> Self::Representation

Converts this node into its representation.

impl<Data: Debug> BranchNode for UnifiedNode<Data>

type ChildrenIter<'branch> = ChildrenLinked<'branch, UnifiedNode<Data>> where Self: 'branch

The iterator returned by children.

fn first(&self) -> Option<Token<Self>>

Returns the token of this branch node’s first child.

fn last(&self) -> Option<Token<Self>>

Returns the token of this branch node’s last child.

fn children<'branch>( &'branch self, arena: &'branch Arena<Self>, ) -> Self::ChildrenIter<'branch>

Returns an iterator over the tokens of this branch node’s children.

fn is_empty(&self) -> bool

Returns whether this branch node has no children.

fn detach_front( token: Self::Token, arena: &mut Arena<Self>, ) -> Option<Token<Self>>

Detaches this branch node’s first child, returning its token.

fn detach_back( token: Self::Token, arena: &mut Arena<Self>, ) -> Option<Token<Self>>

Detaches this branch node’s last child, returning its token.

fn pop_front( token: Self::Token, arena: &mut Arena<Self>, ) -> Option<UnifiedNodeRepresentation<Data>>

Removes this branch node’s first child.

fn pop_back( token: Self::Token, arena: &mut Arena<Self>, ) -> Option<UnifiedNodeRepresentation<Data>>

Removes this branch node’s last child.

fn push_front(token: Self::Token, arena: &mut Arena<Self>, new: Token<Self>)

Pushes the given new token’s node to the beginning of this branch node’s children.

fn push_back(token: Self::Token, arena: &mut Arena<Self>, new: Token<Self>)

Pushes the given new token’s node to the end of this branch node’s children.

fn descendants<'branch>( &'branch self, arena: &'branch Arena<Self::Base>, ) -> Descendants<'branch, Self>

where Self: Sized, for<'base> &'base Self: TryFrom<&'base Self::Base>,

Returns an iterator over the tokens of this branch node’s descendants.

impl<Data: Debug + Debug> Debug for UnifiedNode<Data>

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

Formats the value using the given formatter.

impl<Data: Debug> Hash for UnifiedNode<Data>

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<Data: Debug> LinkedNode for UnifiedNode<Data>

fn prev(&self) -> Option<Token<Self>>

Returns the token of this node’s previous sibling.

fn next(&self) -> Option<Token<Self>>

Returns the token of this node’s next sibling.

fn preceding_siblings<'node>( &'node self, arena: &'node Arena<Self::Base>, ) -> PrecedingSiblings<'node, Self>

where Self: Sized,

Returns an iterator over the tokens of this node’s preceding siblings.

fn following_siblings<'node>( &'node self, arena: &'node Arena<Self::Base>, ) -> FollowingSiblings<'node, Self>

where Self: Sized,

Returns an iterator over the tokens of this node’s following siblings.

impl<Data: Debug> Node for UnifiedNode<Data>

type Base = UnifiedNode<Data>

The ‘base node’ used in the arena.

type Token = Token<UnifiedNode<Data>>

The token associated with this type of node.

type Data = Data

The custom data associated with this node.

type DataRef<'data> = &'data Data where Self: 'data

A type acting as a reference to the node’s data.

type DataRefMut<'data> = &'data mut Data where Self: 'data

A type acting as a mutable reference to the node’s data.

fn new(arena: &mut Arena<Self::Base>, data: Self::Data) -> Self::Token

Creates a new node allocated in the given arena using the given data.

fn token(&self) -> Self::Token

Returns this node’s token.

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

Returns the token of this node’s parent.

fn data(&self) -> &Self::Data

Returns a reference to the data associated with this node.

fn data_mut(&mut self) -> &mut Self::Data

Returns a mutable reference to the data associated with this node.

fn ancestors<'node>( &'node self, arena: &'node Arena<Self::Base>, ) -> Ancestors<'node, Self::Base>

where Self: Sized,

Returns an iterator over the tokens of this node’s ancestors.

fn root<'node>(&'node self, arena: &'node Arena<Self::Base>) -> RootToken<Self>

where Self: Sized,

Returns this node’s root node.

impl<Data: Debug> PartialEq for UnifiedNode<Data>

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<Data: Debug> Eq for UnifiedNode<Data>