Skip to main content

Module model

Module model 

Source
Expand description

Typed result model (WorkbookDiff, SheetDiff, CellDiff, CellValue, …). Public result data model.

All types here are normatively defined in RFC-033. This module owns construction and the summary / change-kind derivation logic; the field shapes are fixed by the canonical lexicon.

Structs§

AlignmentSummary
Summary of row-alignment decisions for a sheet pair (RFC-011).
CellDateTime
Spreadsheet-serial date/time value captured from calamine.
CellDiff
A merged per-cell diff entry (RFC-033 §5).
CellDisplay
Human-friendly display metadata attached to a cell value (RFC-020).
CellDuration
Spreadsheet-serial duration value (ISO 8601 duration string when available).
CellNumberFormat
A number-format identifier and/or code string captured from the workbook.
CellSnapshot
A full snapshot of one cell: typed value + optional formula + optional display metadata (RFC-020).
Diagnostic
A single structured diagnostic entry.
DiagnosticLocation
Location context attached to a diagnostic.
DiagnosticSummary
Diagnostic counts rolled up at any level.
DiffMetrics
Internal processing metrics (RFC-024, RFC-027).
DiffSummary
Top-level workbook diff summary.
FormatChange
Reserved for RFC-022 (style/format diffs). Always None — calamine 0.36 does not expose a cell-style API. Set via FormatCompareMode (currently only Ignore is accepted).
FormulaChange
A formula-layer change at one cell address.
FormulaText
A formula’s text, with an optional normalised form.
SheetDiff
The diff result for one logical sheet pair.
SheetRef
A reference to a specific sheet in one workbook.
SheetSummary
Per-sheet summary counts.
SourceDescription
Caller-visible description of a workbook input source.
ValueChange
A value-layer change at one cell address.
WorkbookChange
Reserved for RFC-021 (workbook metadata diffs). Always empty.
WorkbookDiff
The complete diff result for a workbook pair.
WorkbookObjectChange
Reserved for RFC-023 (non-cell object diffs). Always empty.
WorkbookSideInfo

Enums§

CellChangeKind
Derived classification of a CellDiff entry.
CellError
Typed spreadsheet cell error.
CellValue
Typed representation of a spreadsheet cell value (RFC-033 §2).
DateTimeKind
Whether an Excel date serial represents a date, time, or datetime.
DiagnosticKind
Structured diagnostic kind.
DiffStage
Which processing stage emitted a diagnostic.
DisplaySource
Where a display string originated.
MatchConfidence
How confident the sheet-matching algorithm is about a non-exact pairing.
Severity
Severity of a diagnostic entry.
SheetChange
How a sheet pair was classified.
SheetMatchReason
The reason a non-exact sheet pair was formed.
Side
Which workbook of the pair a piece of data refers to.
SourceKind
What kind of input source a workbook came from.
ValueDifferenceKind
Why two CellValues were considered different.