Expand description
The engine’s modules: sheets and cells, Excel Tables, pivot tables,
charts, styling, VBA, and .xlsx I/O.
The curated re-exports at this module’s root are the intended surface. Modules implementing Excel’s function library are crate-private.
Re-exports§
pub use engine::Bitmask;pub use engine::CellRef;pub use engine::ColumnData;pub use engine::Context;pub use engine::DataColumn;pub use engine::Dependency;pub use engine::Direction;pub use engine::EngineError;pub use engine::EvalError;pub use engine::RefType;pub use engine::ResultData;pub use engine::Sheet;pub use engine::SheetInit;pub use engine::TextCellRef;pub use engine::generate_unique_id;pub use engine::get_word_boundaries_from_str;pub use pivot::PivotAggregation;pub use pivot::PivotArea;pub use pivot::PivotBodyRow;pub use pivot::PivotField;pub use pivot::PivotFilterField;pub use pivot::PivotGrid;pub use pivot::PivotSource;pub use pivot::PivotTable;pub use pivot::PivotValueField;pub use pivot::compute_pivot;pub use pivot::value_field_labels;pub use style::CellStyle;pub use table::ExcelTable;pub use vba::ModuleSyntax;pub use vba::RunOutcome;pub use vba::VbaModule;pub use vba::VbaModuleKind;pub use vba::VbaProject;pub use vba::check_syntax;pub use vba::check_syntax_partial;pub use vba::run_macro;pub use vba::validate_vba_module_name;pub use workbook::SheetSummary;pub use workbook::WorkbookManager;pub use workbook::WorkbookSummary;
Modules§
- chart
- Chart definitions.
- engine
- The spreadsheet engine: sheets, cells, columns and values.
- pivot
- Pivot table definitions and the pure function that computes one.
- style
- Per-cell formatting.
- table
- Excel Tables (ListObjects): named sub-ranges of a worksheet.
- vba
- VBA macro project data model.
- workbook
- Workbook-level orchestration: the sheets, charts, pivot tables and VBA
project of one
.xlsxfile, plus the CRUD and recalculation operations that span more than a singleSheet. - xlsx
- Reading and writing
.xlsxfiles.
Structs§
- Compiled
Formula - A formula split into literal text and id-held references.
- Shared
Vec - A
Vecbehind anArc, cheap to clone and copy-on-write to mutate. - Simple
Date - A calendar date, with no time-of-day and no timezone.
Enums§
- Date
Format - The notation a date was written in: field order, separator, year width and month-name spelling.
- Formula
Part - One piece of a compiled formula: either literal text or a reference held by id.
- Sheet
Action - A single edit made to a workbook, recorded so a host can observe or replay it.
- Sheet
Section - Which part of an Excel Table a structured reference selects, as in
Sales[#Headers]. - String
Case - How a month name was capitalized in the text a date was typed as.
Functions§
- col_
idx_ to_ letters - Renders a 0-based column index as its A1 column letters: 0 is
A, 25 isZ, 26 isAA. - date_
to_ excel_ serial - Converts a date to Excel’s day count, where 1 is 1900-01-01.
- excel_
serial_ to_ date - The inverse of
date_to_excel_serial, for rendering a computed serial. - format_
date - Renders a date back in the notation
parse_daterecognized it in. - is_
date_ code - Whether a number-format code renders a date, as opposed to a numeric
format like
0.00or#,##0. - parse_
a1_ coordinates - Converts an already-split A1 reference into a 0-based
(row, col). - parse_
date - Recognizes a date written as text, returning both the date and the notation it was written in.
- render_
date_ code - Renders a date through an Excel number-format code.