Expand description
Meta crate that re-exports the primary Formualizer building blocks with sensible defaults. Downstream users can depend on this crate and opt into specific layers via feature flags while keeping access to the underlying crates when deeper integration is required.
Inspection DTOs are currently types-only through this facade. Until the
workbook and language-binding integrations land, use formualizer-eval
directly to call the engine inspection methods; the facade intentionally
does not re-export Engine.
Re-exports§
pub use formualizer_common as common;pub use formualizer_parse as parse;pub use formualizer_eval as eval;pub use formualizer_workbook as workbook;pub use formualizer_sheetport as sheetport;pub use sheetport_spec;
Modules§
Structs§
- ASTNode
- An AST node represents a parsed formula element
- Cell
Address - An owned, absolute cell address with 1-based coordinates.
- Cell
Snapshot - Cell
Snapshot Report - Constraint
Violation - Detailed information about why a value failed validation.
- Dependent
- Dependents
Options - Capacity minima that must hold the request’s own anchors are hard errors: trace requires max_nodes >= unique roots (and nonempty roots); range_page requires limit >= 1. All expansion budgets (max_depth, max_links, max_work, range_member_budget, max_results) accept zero and degrade to in-band truncation.
- Dependents
Report - Error
Context - Generic, lightweight metadata that any error may carry.
- Eval
Config - Configuration for the evaluation engine
- Eval
Options - Eval
Plan - Excel
Error - The single struct your API passes around.
- Input
Update - Set of inputs to apply (partial updates allowed).
- Manifest
Bindings - Bound manifest along with per-port selector metadata.
- Parser
- Source-span-backed parser for converting formulas into an AST.
- Port
Binding - Fully resolved port description.
- Precedent
- Precedent
Options - Capacity minima that must hold the request’s own anchors are hard errors: trace requires max_nodes >= unique roots (and nonempty roots); range_page requires limit >= 1. All expansion budgets (max_depth, max_links, max_work, range_member_budget, max_results) accept zero and degrade to in-band truncation.
- Precedent
Report - Range
Address - Range
Area - An owned, absolute range area with optional, inclusive 1-based bounds.
- Range
Page - Range
Page Options - Capacity minima that must hold the request’s own anchors are hard errors: trace requires max_nodes >= unique roots (and nonempty roots); range_page requires limit >= 1. All expansion budgets (max_depth, max_links, max_work, range_member_budget, max_results) accept zero and degrade to in-band truncation.
- Record
Binding - Record port binding with per-field metadata.
- Record
Field Binding - Metadata describing an individual record field binding.
- Scalar
Binding - Scalar port binding.
- Sheet
Port - Runtime container that pairs a manifest with a concrete workbook.
- Snapshot
Options - Capacity minima that must hold the request’s own anchors are hard errors: trace requires max_nodes >= unique roots (and nonempty roots); range_page requires limit >= 1. All expansion budgets (max_depth, max_links, max_work, range_member_budget, max_results) accept zero and degrade to in-band truncation.
- State
Stamp - Correlates a report with the engine mutation and recalculation state from which it was copied.
- Table
Binding - Table port binding with column descriptors.
- Table
Row - Single logical table row.
- Table
Value - Table-shaped value consisting of ordered rows.
- Token
- A token in an Excel formula.
- Tokenizer
- A tokenizer for Excel worksheet formulas.
- Trace
Graph - Trace
Link - Trace
Link Target - Trace
Node - Trace
Node Id - Trace
Options - Capacity minima that must hold the request’s own anchors are hard errors: trace requires max_nodes >= unique roots (and nonempty roots); range_page requires limit >= 1. All expansion budgets (max_depth, max_links, max_work, range_member_budget, max_results) accept zero and degrade to in-band truncation.
- Truncation
Report - Workbook
- Engine-backed workbook facade.
- Workbook
Config - Worksheet
Handle - A bindings-friendly worksheet handle backed by an Arc<RwLock
>. For native Rust, prefer borrowing APIs on Workbookdirectly for better ergonomics.
Enums§
- ASTNode
Type - The different types of AST nodes.
- Area
Location - Location for ports that span an area (records or rectangular ranges).
- Bound
Port - Union of bound port kinds.
- Date
System - Excel
Error Extra - Kind-specific payloads (“extension slot”).
- Excel
Error Kind - All recognised Excel error codes.
- Formula
Dialect - Inspect
Error - Inspection
Unavailable Reason - Link
Disposition - Literal
Value - An interpeter LiteralValue. This is distinct from the possible types that can be stored in a cell.
- Load
Strategy - Name
Resolution - Omitted
Count - Port
Value - Generic value container for a manifest port.
- Provenance
- Reference
Type - A reference to something outside the cell.
- Scalar
Location - Location for scalar ports.
- Semantic
Reference - Sheet
Port Error - Errors produced when constructing or operating a SheetPort runtime.
- Spill
Role - A last-evaluation spill-registry fact.
- Staleness
- Table
Location - Location options for table-shaped ports.
- Token
SubType - The subtype of a token.
- Token
Type - The type of a token.
- Trace
Direction - Trace
Link Kind - Workbook
Mode
Functions§
- canonical_
formula - Produce a canonical Excel formula string for an AST, prefixed with ‘=’.
- parse_
with_ dialect