Enum DiagnosticKind 

#[non_exhaustive]
pub enum DiagnosticKind {
    FormulaUnavailable,
    FormulaCachedValueUnverified,
    AmbiguousSheetMatch {
        candidates: Vec<SheetRef>,
    },
    UnsupportedCellValue {
        detail: String,
    },
    UnsupportedWorkbookFeature {
        feature: String,
    },
    UnsupportedWorkbookMetadata {
        category: String,
    },
    DefinedNameScopeUnknown,
    DateTimeNotNormalized,
    LimitTruncatedCells {
        limit: String,
        observed: u64,
    },
}

Structured diagnostic kind.

code() returns a stable string identifier for serde / localisation; it is never renamed within a major version.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FormulaUnavailable

FormulaCachedValueUnverified

AmbiguousSheetMatch

Fields

candidates: Vec<SheetRef>

UnsupportedCellValue

Fields

detail: String

UnsupportedWorkbookFeature

Fields

feature: String

UnsupportedWorkbookMetadata

Fields

category: String

DefinedNameScopeUnknown

DateTimeNotNormalized

LimitTruncatedCells

Fields

limit: String

observed: u64

Implementations

impl DiagnosticKind

pub fn code(&self) -> &'static str

Stable code string for this diagnostic kind.

These strings are the stable programmatic surface for diagnostics. Match on code() rather than on the #[non_exhaustive] enum variants: new variants may be added in a minor release (which would break an exhaustive match on the enum), but an existing code string is never renamed within a major version. Codes also appear verbatim in serialised JSON.

The complete set of codes in this major version:

Code	Meaning
formula_unavailable	A cell’s formula text could not be read
formula_cached_value_unverified	A formula’s cached value could not be verified
ambiguous_sheet_match	Sheet rename detection found more than one candidate
unsupported_cell_value	A cell value could not be normalised to a CellValue
unsupported_workbook_feature	A non-cell object/sheet type is present but not compared
unsupported_workbook_metadata	A defined-name / visibility / metadata change was detected
defined_name_scope_unknown	Defined-name scope is unavailable from the reader
datetime_not_normalized	A date/time value could not be normalised to ISO form
limit_truncated_cells	A configured cell limit truncated the comparison

New codes added in later minor versions will extend this table; existing rows are stable.

Trait Implementations

impl Clone for DiagnosticKind

fn clone(&self) -> DiagnosticKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagnosticKind

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

Formats the value using the given formatter.

impl Eq for DiagnosticKind

impl PartialEq for DiagnosticKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DiagnosticKind