Expand description
Public TeXForm facade.
This crate exposes the stable user-facing API: parse-only Parser,
normalization TransformEngine, AST serialization, argspec validation, and
analysis helpers.
Re-exports§
pub use argspec::ArgSpecFormInfo;pub use argspec::ArgSpecKindInfo;pub use argspec::DelimiterTokenInfo;pub use argspec::DelimiterTokenPairInfo;pub use argspec::ParsedArgSpecSlot;pub use argspec::RuntimeContentModeInfo;pub use argspec::ValidateArgspecResult;pub use argspec::validate_argspec;pub use config::NormalizeConfig;pub use config::rule_key_from_name;pub use document::Document;pub use document::NodeSpanEntry;pub use error::Error;pub use error::NormalizeError;pub use error::TransformBuildError;pub use error::TransformError;pub use knowledge::PackageInfo;pub use knowledge::list_packages;pub use parse_result::ParseError;pub use parse_result::ParseResult;pub use parser::Parser;pub use parser::ParserBuildError;pub use parser::ParserBuilder;pub use transform_engine::NormalizeResult;pub use transform_engine::TransformEngine;pub use transform_engine::TransformEngineBuilder;
Modules§
- analysis
- argspec
- config
- document
- error
- knowledge
- Knowledge-base package metadata.
- parse_
result - parser
- serialize
- transform_
engine
Structs§
- Active
Character Record - Active
Command Record - Active
Delimiter Record - Active
Environment Record - Argument
- Command or environment argument.
- Attribute
Form Counts - Declarative/prefix split for a single attribute statistic bucket.
- Attribute
Set - Attribute
Stat - Command
Item - Runtime command definition to be injected into a
ParseContext. - Delimiter
Control Item - Runtime delimiter control sequence to be registered in the knowledge base.
- Document
Id - Process-wide unique identity for a
Document. - Environment
Item - Runtime environment definition to be injected into a
ParseContext. - Finalize
AstConfig - Finalize
AstReport - Finalize
AstStep Report - Finalize
AstStep Reports - Flatten
Groups Action Counts - Flatten
Groups Config - Flatten
Groups Guard Counts - Flatten
Groups Report - Lower
Attributes Config - Lower
Attributes Report - Statistics accumulated across every LowerAttributes invocation in one transform run.
- Math
Font Value - NodeId
- Public node handle.
- NodeRef
- Read-only borrowed handle to a node within a
Document. - Normalization
Level Set - Parse
Config - Parse-time configuration knobs.
- Parse
Diagnostic - A single diagnostic produced during parsing.
- Parse
Diagnostic Context - Additional source span attached to a diagnostic.
- Rewrite
Report - Accumulates statistics across an entire rewrite pass.
- Rewrite
Rule Stat - Tracks how often a specific rule changed the AST or skipped after a scheduling target match.
- RuleKey
- Unique identifier for a rule, composed of its package and a human-readable name.
- Serialize
Options - Top-level serialization options, grouped by scope.
- Size
Value - Stable scaled-integer representation of a size factor (value × 100 rounded).
Avoids using a bare
f64as aEq + Hashkey. - Span
- Byte-offset span within the original source string.
- Style
Value - Transform
Config - Transform
Report
Enums§
- Allowed
Mode - ArgRef
- Read-side view of one command/environment argument value.
- ArgValue
- Write-side command/environment argument value.
- Argument
Kind - Argument type.
- Argument
Value - Parsed argument value.
- Attr
- One of the attribute axes recognised by the phase.
- Attr
Value - Canonical value carried by an attribute slot.
- Command
Kind - Content
Mode - Content mode: math or text
- Context
Item - A runtime-injectable definition that augments the knowledge base.
- Delimiter
- Delimiter type for delimited groups
- Delimiter
Ref - Delimiter
Value - Public write-side delimiter value.
- Edit
Error - Fallible editing error from
Documentmutation APIs. - From
Syntax Error - Error from
Document::from_syntax. - Group
Kind - Group type for different grouping constructs
- Group
Kind Ref - Node
Kind - Cheap node discriminant for queries that do not need full pattern matching.
- Package
Load Error - Error returned when a requested package name is not found in the registry.
- Parse
Diagnostic Kind - Profile
- Serialize
Error - Error type for fallible LaTeX serialization.
- Syntax
Node - Immutable syntax tree node
- Text
Family - Text
Series - Text
Shape
Type Aliases§
- Argument
Slot - Optional slot for argument lists.