[][src]Module outline::parser

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

bird

The parser for Bird Style literate programming.

html

The parser for HTML based literate programming.

md

The parser for Markdown based literate programming.

tex

The parser for TeX based literate programming.

Enums

ParseError

A generic parse error

Traits

Parser

A Parser determines which lines are code and which are text, and may use its Config to actually handle reading the lines of code

ParserConfig

A ParserConfig can be used to customize the built in parsing methods

Printer

A Printer can invert the parsing process, printing the code blocks how they should be rendered in the documentation text.