Enum SplitToken

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

Available on crate feature split only.

The token type referring to a SplitNode.

Variants

Branch(Token<Branch<BranchData, LeafData>>)

A branch node’s token.

Leaf(Token<Leaf<BranchData, LeafData>>)

A leaf node’s token.

Implementations

impl<BranchData, LeafData> SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

pub const fn new_branch(token: Token<Branch<BranchData, LeafData>>) -> Self

Creates a new SplitToken for a branch from the given token.

pub const fn new_leaf(token: Token<Leaf<BranchData, LeafData>>) -> Self

Creates a new SplitToken for a leaf from the given token.

Trait Implementations

impl<BranchData, LeafData> Clone for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<BranchData, LeafData> Debug for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

Formats the value using the given formatter.

impl<BranchData, LeafData> Hash for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

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

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.

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

where N::Base: LinkedNode,

Returns the token of this node’s previous sibling.

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

where N::Base: LinkedNode,

Returns the token of this node’s next sibling.

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

where N::Base: LinkedNode,

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

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

where N::Base: LinkedNode,

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

impl<BranchData, LeafData, I: Idx> PartialEq<I> for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

fn eq(&self, other: &I) -> 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<BranchData, LeafData> Copy for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,

impl<BranchData, LeafData> Eq for SplitToken<BranchData, LeafData>

where BranchData: Debug, LeafData: Debug,