Struct WorkbookDiff 

#[non_exhaustive]
pub struct WorkbookDiff {
    pub old: WorkbookSideInfo,
    pub new: WorkbookSideInfo,
    pub sheets: Vec<SheetDiff>,
    pub workbook_changes: Vec<WorkbookChange>,
    pub object_changes: Vec<WorkbookObjectChange>,
    pub diagnostics: Vec<Diagnostic>,
    pub summary: DiffSummary,
    pub metrics: DiffMetrics,
}

The complete diff result for a workbook pair.

workbook_changes and object_changes are always empty — RFC-021/023 surface their findings through diagnostics, and structured variants await a future release. The struct is #[non_exhaustive] so they can be populated additively without a breaking change.

Extracting a lightweight summary

summary (DiffSummary), metrics (DiffMetrics), and each sheet’s change (SheetChange) are all cheap, small, owned values. Memory-conscious consumers that only need counts and the sheet-change list can clone those out and drop the whole WorkbookDiff — including the potentially large sheets[..].cell_diffs vectors — at their adapter boundary:

let diff = compare_paths("a.xlsx", "b.xlsx")?;
let summary = diff.summary.clone();        // cheap
let metrics = diff.metrics.clone();        // cheap
let sheet_changes: Vec<_> =
    diff.sheets.iter().map(|s| s.change.clone()).collect();
drop(diff);                                 // releases all cell_diffs

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

old: WorkbookSideInfo

new: WorkbookSideInfo

sheets: Vec<SheetDiff>

Sheet diffs in old-workbook sheet order (then new-workbook order for added sheets).

workbook_changes: Vec<WorkbookChange>

Always empty; reserved for future structured workbook-level changes.

object_changes: Vec<WorkbookObjectChange>

Always empty; reserved for future structured object-level changes.

diagnostics: Vec<Diagnostic>

summary: DiffSummary

metrics: DiffMetrics

Processing metrics for benchmarking and performance analysis (RFC-024/027).

Trait Implementations

impl Clone for WorkbookDiff

fn clone(&self) -> WorkbookDiff

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkbookDiff

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WorkbookDiff

fn eq(&self, other: &WorkbookDiff) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WorkbookDiff