Module rustla::doctree[][src]

This module defines the document tree and its nodes. The implementation is in the form of a zipper: the DocTree is a container for the metadata (such as hyperlinks) related to the parsing of the tree and store the tree in the form a a TreeZipper in its field DocTree.tree. The TreeZipper type is specified in the submodule crate::parser::tree_zipper.

Copyright © 2020 Santtu Söderholm

Modules

directives

A submodule that contains an enumeration for the different directive types recognized by reStructuredText and associated functions and metods. The documentation found in the comments in this file was taken from https://docutils.sourceforge.io/docs/ref/rst/directives.html

tree_node

A submodule for the TreeNode type.

tree_node_types

A submodule that contains the different tree node types as a single huge enumeration.

Structs

DocTree

A container for the document tree. In addition to holding ownership of the tree (stored in a zipper), also contains metadata about the tree.