Skip to main content

Crate rdx_transform

Crate rdx_transform 

Source

Structs§

AbbreviationExpand
Reads abbreviations from the document frontmatter and wraps the first occurrence of each abbreviation in the document text with an <Abbr> inline component that carries a title attribute containing the expansion.
AlignRow
A row in an alignment environment (align/alignat).
AlignRowResolver
The resolver for an archived AlignRow
ArchivedAlignRow
An archived AlignRow
ArchivedAttributeNode
An archived AttributeNode
ArchivedCaseRow
An archived CaseRow
ArchivedCitationKey
An archived CitationKey
ArchivedCitationNode
An archived CitationNode
ArchivedCodeBlockNode
An archived CodeBlockNode
ArchivedCodeInlineNode
An archived CodeInlineNode
ArchivedComponentNode
An archived ComponentNode
ArchivedCrossRefNode
An archived CrossRefNode
ArchivedErrorNode
An archived ErrorNode
ArchivedFootnoteNode
An archived FootnoteNode
ArchivedImageNode
An archived ImageNode
ArchivedLinkNode
An archived LinkNode
ArchivedMathDisplayNode
An archived MathDisplayNode
ArchivedMathNode
An archived MathNode
ArchivedMathOperator
An archived MathOperator
ArchivedPoint
An archived Point
ArchivedPosition
An archived Position
ArchivedRoot
An archived Root
ArchivedStandardBlockNode
An archived StandardBlockNode
ArchivedTextNode
An archived TextNode
ArchivedVariableNode
An archived VariableNode
AttributeNode
A single attribute with its own positional data.
AttributeNodeResolver
The resolver for an archived AttributeNode
AutoNumber
Walks the AST and assigns sequential numbers to figures, tables, listings, theorem-group components, definition-group components, display math equations, and headings.
AutoSlug
Generates URL-safe slugs for headings and sets the id field.
BibEntry
A parsed bibliography entry with just the fields we need for formatting.
CaseRow
A row in a cases environment.
CaseRowResolver
The resolver for an archived CaseRow
CitationKey
A single citation key with optional prefix and locator.
CitationKeyResolver
The resolver for an archived CitationKey
CitationNode
A citation reference node containing one or more citation keys.
CitationNodeResolver
The resolver for an archived CitationNode
CitationResolve
Resolve citation keys against a bibliography and inject formatted text.
CodeBlockNode
A fenced code block with optional language, meta string, and display metadata.
CodeBlockNodeResolver
The resolver for an archived CodeBlockNode
CodeInlineNode
An inline code node with optional language hint.
CodeInlineNodeResolver
The resolver for an archived CodeInlineNode
ComponentNode
An RDX component node.
ComponentNodeResolver
The resolver for an archived ComponentNode
CrossRefNode
A cross-reference node pointing to a labeled element elsewhere in the document.
CrossRefNodeResolver
The resolver for an archived CrossRefNode
CrossRefResolve
Resolves Node::CrossRef nodes by looking up their target label in a NumberRegistry produced by crate::AutoNumber.
ErrorNode
An explicit error node for host-level error boundaries.
ErrorNodeResolver
The resolver for an archived ErrorNode
FootnoteNode
A footnote node (definition or reference).
FootnoteNodeResolver
The resolver for an archived FootnoteNode
ImageNode
An image node with URL, optional title, and alt text.
ImageNodeResolver
The resolver for an archived ImageNode
LinkNode
A link node with URL and optional title.
LinkNodeResolver
The resolver for an archived LinkNode
MathDisplayNode
A display math expression node containing raw LaTeX, a structured parse tree, and an optional label.
MathDisplayNodeResolver
The resolver for an archived MathDisplayNode
MathNode
An inline math expression node containing raw LaTeX and a structured parse tree.
MathNodeResolver
The resolver for an archived MathNode
MathOperator
A mathematical operator symbol with its classification.
MathOperatorResolver
The resolver for an archived MathOperator
NumberEntry
A single numbered element’s metadata.
NumberRegistry
Maps label strings to their numbered entries.
Pipeline
A composable pipeline that parses an RDX document and runs a chain of transforms.
Point
PointResolver
The resolver for an archived Point
Position
Positional data mapping an AST node back to its source .rdx file. Line and column numbers are 1-indexed. Offsets are 0-indexed byte offsets.
PositionResolver
The resolver for an archived Position
PrintFallback
When producing print output, replaces components that carry a printFallback attribute with a simpler representation.
Root
The root of an RDX document.
RootResolver
The resolver for an archived Root
StandardBlockNode
A standard CommonMark block node.
StandardBlockNodeResolver
The resolver for an archived StandardBlockNode
StripTarget
Removes nodes that are targeted at an output that does not match the current render target.
TableOfContents
Generates a table of contents from document headings and inserts it as a <TableOfContents> component node.
TextNode
A literal text node.
TextNodeResolver
The resolver for an archived TextNode
VariableNode
A variable interpolation node.
VariableNodeResolver
The resolver for an archived VariableNode

Enums§

AccentKind
Accent mark kind.
AccentKindResolver
The resolver for an archived AccentKind
ArchivedAccentKind
An archived AccentKind
ArchivedAttributeValue
An archived AttributeValue
ArchivedColumnAlign
An archived ColumnAlign
ArchivedDelimiter
An archived Delimiter
ArchivedFracStyle
An archived FracStyle
ArchivedLimitStyle
An archived LimitStyle
ArchivedMathExpr
An archived MathExpr
ArchivedMathFont
An archived MathFont
ArchivedMathSpace
An archived MathSpace
ArchivedMathStyle
An archived MathStyle
ArchivedMatrixDelimiters
An archived MatrixDelimiters
ArchivedNode
An archived Node
ArchivedOperatorKind
An archived OperatorKind
ArchivedRootType
An archived RootType
ArchivedSmashMode
An archived SmashMode
AttributeValue
Supported attribute value types.
AttributeValueResolver
The resolver for an archived AttributeValue
CitationStyle
ColumnAlign
Column alignment specifier for array environments.
ColumnAlignResolver
The resolver for an archived ColumnAlign
Delimiter
A delimiter character used in fenced expressions.
DelimiterResolver
The resolver for an archived Delimiter
FracStyle
Style for fraction rendering.
FracStyleResolver
The resolver for an archived FracStyle
LimitStyle
Limit placement style for big operators.
LimitStyleResolver
The resolver for an archived LimitStyle
MathExpr
Structured math expression tree (Section 2.11).
MathExprResolver
The resolver for an archived MathExpr
MathFont
Math font override.
MathFontResolver
The resolver for an archived MathFont
MathSpace
Named math spacing amounts.
MathSpaceResolver
The resolver for an archived MathSpace
MathStyle
Math style (display size) override.
MathStyleResolver
The resolver for an archived MathStyle
MatrixDelimiters
Delimiter style for matrix environments.
MatrixDelimitersResolver
The resolver for an archived MatrixDelimiters
Node
A union of all possible RDX nodes.
NodeResolver
The resolver for an archived Node
OperatorKind
Classification of a mathematical operator.
OperatorKindResolver
The resolver for an archived OperatorKind
RootType
RootTypeResolver
The resolver for an archived RootType
SmashMode
Smash mode indicating which dimension to suppress.
SmashModeResolver
The resolver for an archived SmashMode

Traits§

Transform
A transform that operates on an RDX AST in place.

Functions§

collect_text
Extract plain text from a list of nodes (for generating slugs, alt text, etc).
parse
Parse an RDX document string into a compliant AST.
parse_with_defaults
Convenience: parse + apply built-in transforms (slug + toc).
synthetic_pos
Build a synthetic Position for AST nodes that are generated by a transform rather than parsed from source text.
walk
Walk all nodes immutably.
walk_mut
Walk all nodes in the AST, calling f on each with a mutable reference. Useful for implementing transforms.