Enum SplitNodeDeque

pub enum SplitNodeDeque<BranchData: Debug, LeafData: Debug> {
    Branch(BranchDeque<BranchData, LeafData>),
    Leaf(LeafDeque<BranchData, LeafData>),
}

Available on crate features deque and split only.

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

This is the deque version, where children are represented as a VecDeque. In this version, a node’s previous sibling(s) and next sibling(s) are not available, but branches can be directly indexed, and children can be detached, removed, or inserted by index.

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

See also

For the non-deque version, see SplitNode. For a node that isn’t split into separate branch and leaf nodes, see UnifiedNode and UnifiedNodeDeque.

Variants

Branch(BranchDeque<BranchData, LeafData>)

Leaf(LeafDeque<BranchData, LeafData>)

Trait Implementations

impl<BranchData, LeafData> BaseNode for SplitNodeDeque<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 = BranchDeque<BranchData, LeafData>

The type used for branch nodes.

type Leaf = LeafDeque<BranchData, LeafData>

The type used for leaf nodes.

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

where Self: Sized,

Converts this node into its representation.

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

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

Formats the value using the given formatter.

impl<BranchData, LeafData> Node for SplitNodeDeque<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

type Base = SplitNodeDeque<BranchData, LeafData>

The ‘base node’ used in the arena.

type Token = SplitTokenDeque<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<<<Self::Base as BaseNode>::Branch as Node>::Token>

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<SplitNodeDeque<BranchData, LeafData>> for SplitTokenDeque<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.

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

where for<'base> &'base N: TryFrom<&'base N::Base>, for<'base> <&'base N as TryFrom<&'base N::Base>>::Error: Debug,

Returns this node’s root node.

fn data<'arena>(&self, arena: &'arena Arena<N::Base>) -> N::DataRef<'arena>

where for<'base> &'base N: TryFrom<&'base N::Base>, for<'base> <&'base N as TryFrom<&'base N::Base>>::Error: Debug,

Returns a reference to the data associated with this node.

fn data_mut<'arena>( &self, arena: &'arena mut Arena<N::Base>, ) -> N::DataRefMut<'arena>

where for<'base> &'base mut N: TryFrom<&'base mut N::Base>, for<'base> <&'base mut N as TryFrom<&'base mut N::Base>>::Error: Debug,

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

impl<'node, BranchData, LeafData> TryFrom<&'node SplitNodeDeque<BranchData, LeafData>> for &'node BranchDeque<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node SplitNodeDeque<BranchData, LeafData>> for &'node LeafDeque<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node mut SplitNodeDeque<BranchData, LeafData>> for &'node mut BranchDeque<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'node, BranchData, LeafData> TryFrom<&'node mut SplitNodeDeque<BranchData, LeafData>> for &'node mut LeafDeque<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

The type returned in the event of a conversion error.

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

Performs the conversion.