Enum generational_arena_tree::split::SplitNode

pub enum SplitNode<BranchData: Debug, LeafData: Debug> {
    Branch(Branch<BranchData, LeafData>),
    Leaf(Leaf<BranchData, LeafData>),
}

Available on crate feature split only.

A node that is split into separate branch and leaf nodes.

BranchData represents the custom data associated with branches, while LeafData represents the custom data associated with leaves.

See also

For the deque version, see SplitNodeDeque.

For a node that isn’t split into separate branch and leaf nodes, see UnifiedNode and UnifiedNodeDeque.

Variants

Branch(Branch<BranchData, LeafData>)

A branch node that may have children.

Leaf(Leaf<BranchData, LeafData>)

A leaf node that may not have children.

Trait Implementations

impl<BranchData, LeafData> BaseNode for SplitNode<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Representation = SplitNodeRepresentation<BranchData, LeafData>

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

type Branch = Branch<BranchData, LeafData>

The type used for branch nodes.

type Leaf = Leaf<BranchData, LeafData>

The type used for leaf nodes.

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

Converts this node into its representation.

impl<BranchData: Debug + Debug, LeafData: Debug + Debug> Debug for SplitNode<BranchData, LeafData>

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

Formats the value using the given formatter.

impl<BranchData, LeafData> LinkedNode for SplitNode<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

Returns the token of this node’s previous sibling.

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

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<BranchData, LeafData> Node for SplitNode<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Base = SplitNode<BranchData, LeafData>

The ‘base node’ used in the arena.

type Token = SplitToken<BranchData, LeafData>

The token associated with this type of node.

type Data = SplitData<BranchData, LeafData>

The custom data associated with this node.

type DataRef<'data> = SplitData<&'data BranchData, &'data LeafData> where Self: 'data

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

type DataRefMut<'data> = SplitData<&'data mut BranchData, &'data mut LeafData> where Self: 'data

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

fn new(arena: &mut Arena<Self>, 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 as BaseNode>::Branch>>

Returns the token of this node’s parent.

fn data(&self) -> Self::DataRef<'_>

Returns a reference to the data associated with this node.

fn data_mut(&mut self) -> Self::DataRefMut<'_>

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<BranchData, LeafData> NodeToken<SplitNode<BranchData, LeafData>> for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

fn parent( &self, arena: &Arena<N::Base> ) -> Option<<<N::Base as BaseNode>::Branch as Node>::Token>

Returns this node’s parent’s token.

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

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

impl<'node, BranchData, LeafData> TryFrom<&'node SplitNode<BranchData, LeafData>> for &'node Branch<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Error = &'node SplitNode<BranchData, LeafData>

The type returned in the event of a conversion error.

fn try_from( node: &'node SplitNode<BranchData, LeafData> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node SplitNode<BranchData, LeafData>> for &'node Leaf<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Error = &'node SplitNode<BranchData, LeafData>

The type returned in the event of a conversion error.

fn try_from( node: &'node SplitNode<BranchData, LeafData> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node mut SplitNode<BranchData, LeafData>> for &'node mut Branch<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Error = &'node mut SplitNode<BranchData, LeafData>

The type returned in the event of a conversion error.

fn try_from( node: &'node mut SplitNode<BranchData, LeafData> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node mut SplitNode<BranchData, LeafData>> for &'node mut Leaf<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Error = &'node mut SplitNode<BranchData, LeafData>

The type returned in the event of a conversion error.

fn try_from( node: &'node mut SplitNode<BranchData, LeafData> ) -> Result<Self, Self::Error>

Performs the conversion.