Module charcoal::traversal[−][src]

Everything related to traversing trees in general.

The module is home to the following items:

Visitor and VisitorMut — two similar traits for types which describe algorithms with state
Traversable and its optional extension, TraversableMut — traits for types which describe tree-like structures which can be traversed by Visitor and VisitorMut algorithms
Implementations of ubiquitous algorithms for trees (see the algorithms module for more)
Niche TraverseIter and TraverseMutIter helpers, wrapping a Visitor/Traversable or VisitorMut/TraversableMut pair into an iterator interface
Helper types: Step, VisitorDirection and CursorDirectionError

Modules

Ubiquitous algorithms for trees.

CursorDirectionError	The error returned by traversables when a visitor gives incorrect directions for the cursor.
TraverseIter	An iterator which groups a `Traversable` and a `Visitor`, performing one step with each iteration.
TraverseMutIter	An iterator which groups a `TraversableMut` and a `VisitorMut`, performing one step with each iteration.

Step	The result of a single traversal step.
VisitorDirection	The direction in which a visitor wishes to go after visiting a node.

Traversable	Data structures which can be traversed using `Visitor`s.
TraversableMut	Data structures which can be traversed using `VisitorMut`s, giving them mutable access to the stored data.
Visitor	Iterator-like structures which control a traversable tree’s cursor and use it to read information from the tree.
VisitorMut	A version of `Visitor` with an added ability to acquire mutable access to the tree’s nodes.

A result type for functions receiving or returning a cursor which has possibly been incorrectly driven.