Module outline::parser

source ·
Expand description

The built in parsers

Additional parsers should implement the Parser trait, as well as define a corresponding ParserConfig type to allow configuring that parser.

Additionally, for each parser, a Printer is needed to be able to write the code back out correctly.

Re-exports

pub use self::bird::BirdParser;
pub use self::md::MdParser;
pub use self::tex::TexParser;
pub use self::html::HtmlParser;

Modules

The parser for Bird Style literate programming.
The parser for HTML based literate programming.
The parser for Markdown based literate programming.
The parser for TeX based literate programming.

Enums

A generic parse error

Traits

A Parser determines which lines are code and which are text, and may use its Config to actually handle reading the lines of code
A ParserConfig can be used to customize the built in parsing methods
A Printer can invert the parsing process, printing the code blocks how they should be rendered in the documentation text.