Skip to main content

Module core

Module core 

Source
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::CellType;
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 locale::DateOrder;
pub use locale::Locale;
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 and workbook chart helpers.
engine
Spreadsheet engine types for cells, columns, sheets, and evaluation.
locale
Locale settings used for date parsing and formatting.
pivot
Pivot table definitions and computation helpers.
style
Cell style data used by sheets and file I/O.
table
Excel table metadata and structured-reference helpers.
vba
VBA project, module, syntax-checking, and macro execution support.
workbook
Workbook-level management APIs over sheets and workbook objects.
xlsx
Import and export support for .xlsx workbooks.

Structs§

CompiledFormula
A formula split into literal text and id-held references.
SharedVec
A Vec behind an Arc, cheap to clone and copy-on-write to mutate.
SimpleDate
A calendar date, with no time-of-day and no timezone.

Enums§

DateFormat
The notation a date was written in: field order, separator, year width and month-name spelling.
FormulaPart
One piece of a compiled formula: either literal text or a reference held by id.
SheetAction
A single edit made to a workbook, recorded so a host can observe or replay it.
SheetSection
Which part of an Excel Table a structured reference selects, as in Sales[#Headers].
StringCase
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 is Z, 26 is AA.
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_date recognized it in.
is_date_code
[AI-Agent] Whether a number-format code renders a date rather than a numeric or time value.
parse_a1_coordinates
Converts an already-split A1 reference into a 0-based (row, col).
parse_date
Recognizes a date written as text using the default US locale.
parse_date_with_locale
Recognizes a date written as text according to a specific Locale.
render_date_code
Renders a date through an Excel number-format code.