Struct Token

pub struct Token<N: Node> { /* private fields */ }

Trait Implementations

impl<N: Node> Clone for Token<N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Node> Debug for Token<N>

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

Formats the value using the given formatter.

impl<N: Node> Hash for Token<N>

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<N: Node<Token = Self>> NodeToken<N> for Token<N>

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.

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

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

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

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

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

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

fn children<'arena>( &self, arena: &'arena Arena<N::Base>, ) -> N::ChildrenIter<'arena>

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

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

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

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

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

fn len(&self, arena: &Arena<N::Base>) -> usize

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

Available on crate feature deque only.

Returns the number of children this branch node has.

fn is_empty(&self, arena: &Arena<N::Base>) -> bool

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

Returns whether this branch node has no children.

fn get_unchecked( &self, arena: &Arena<N::Base>, index: usize, ) -> <N::Base as Node>::Token

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

Available on crate feature deque only.

Returns the token of the child at the given index.

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

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

Available on crate feature deque only.

Returns the token of the child at the given index.

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

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

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

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

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

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

fn pop_front( &self, arena: &mut Arena<N::Base>, ) -> Option<<N::Base as BaseNode>::Representation>

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

Removes this branch node’s first child.

fn pop_back( &self, arena: &mut Arena<N::Base>, ) -> Option<<N::Base as BaseNode>::Representation>

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

Removes this branch node’s last child.

fn push_front(&self, arena: &mut Arena<N::Base>, new: <N::Base as Node>::Token)

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

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

fn push_back(&self, arena: &mut Arena<N::Base>, new: <N::Base as Node>::Token)

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

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

fn detach( &self, arena: &mut Arena<N::Base>, index: usize, ) -> <N::Base as Node>::Token

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

Available on crate feature deque only.

Detaches the child at the given index, returning its token.

fn remove( &self, arena: &mut Arena<N::Base>, index: usize, ) -> <N::Base as BaseNode>::Representation

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

Available on crate feature deque only.

Removes the child at the given index.

fn insert( &self, arena: &mut Arena<N::Base>, index: usize, new: <N::Base as Node>::Token, )

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

Available on crate feature deque only.

Inserts the given new token’s node at the given index.

impl<N: Node, I: Idx> PartialEq<I> for Token<N>

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<N: Node> Copy for Token<N>

impl<N: Node> Eq for Token<N>