Expand description
Optional ordered passes over Ferromark’s arena-backed Markdown AST.
This crate depends on ferromark and is not a dependency of the core
parser or renderer. Construct a TransformPipeline only when AST passes
are needed; an empty pipeline performs no traversal or URL scan.
§Custom pass
A pass borrows the parsed document and arena for one call. The same pass
object can be reused for later documents, but it must not retain references
into an arena that the caller may reset. See the packaged
custom pass example.
Pass objects are Send, so callers can move a configured pipeline to the
thread that owns a document; documents and contexts stay thread-local.
Structs§
- Emoji
Shortcodes Pass - Replaces known
gemoji@8.1.0shortcode aliases in prose with Unicode emoji. - GitHub
References Pass - Links a qualified subset of GitHub references using an explicit repository.
- Invalid
GitHub Repository - Error returned when a configured GitHub repository is not a safe
owner/repopath. - Table
OfContents Error - Error returned when an outline entry cannot become a TOC link.
- TextRun
- A maximal sequence of adjacent
Textnodes in one sibling list. - Text
Runs - Iterator over maximal adjacent text runs in a node slice.
- Text
Segment - One decoded text segment and the source range of its AST node.
- Transform
Context - Context available to a pass while one document is being transformed.
- Transform
Error - Error from a pass, including its ordered identity in the pipeline.
- Transform
Pipeline - Ordered collection of reusable AST transform passes.
- Typography
Options - Configuration for the optional typography pass.
- Typography
Pass - A pass that applies explicit language-aware typography to prose text.
- Unsupported
Typography Language - Error returned when a language code is not supported by the typography pass.
Enums§
- Text
Replacement Error - Error returned when a pass replaces an invalid node or text range.
- Typography
Language - A supported language for the optional typography pass.
Traits§
- Transform
Pass - A stateful pass over one parsed document.
Functions§
- build_
table_ of_ contents - Builds a nested unordered-list AST node from one document outline.
- text_
runs - Iterates over maximal adjacent
Textruns in one sibling list.
Type Aliases§
- BoxError
- The boxed, thread-safe error type returned by custom transform passes.