Skip to main content

icydb_core/error/
mod.rs

1//! Module: error
2//!
3//! Defines the canonical runtime error taxonomy for `icydb-core`.
4//! This module owns the shared error classes, origins, details, and
5//! constructor entry points used across storage, planning, execution, and
6//! serialization boundaries.
7
8#[cfg(test)]
9mod tests;
10
11use std::fmt;
12use thiserror::Error as ThisError;
13
14// ============================================================================
15// INTERNAL ERROR TAXONOMY — ARCHITECTURAL CONTRACT
16// ============================================================================
17//
18// This file defines the canonical runtime error classification system for
19// icydb-core. It is the single source of truth for:
20//
21//   • ErrorClass   (semantic domain)
22//   • ErrorOrigin  (subsystem boundary)
23//   • Structured detail payloads
24//   • Canonical constructor entry points
25//
26// -----------------------------------------------------------------------------
27// DESIGN INTENT
28// -----------------------------------------------------------------------------
29//
30// 1. InternalError is a *taxonomy carrier*, not a formatting utility.
31//
32//    - ErrorClass represents semantic meaning (corruption, invariant_violation,
33//      unsupported, etc).
34//    - ErrorOrigin represents the subsystem boundary (store, index, query,
35//      executor, serialize, interface, etc).
36//    - The (class, origin) pair must remain stable and intentional.
37//
38// 2. Call sites MUST prefer canonical constructors.
39//
40//    Do NOT construct errors manually via:
41//        InternalError::new(class, origin, ...)
42//    unless you are defining a new canonical helper here.
43//
44//    If a pattern appears more than once, centralize it here.
45//
46// 3. Constructors in this file must represent real architectural boundaries.
47//
48//    Add a new helper ONLY if it:
49//
50//      • Encodes a cross-cutting invariant,
51//      • Represents a subsystem boundary,
52//      • Or prevents taxonomy drift across call sites.
53//
54//    Do NOT add feature-specific helpers.
55//    Do NOT add one-off formatting helpers.
56//    Do NOT turn this file into a generic message factory.
57//
58// 4. ErrorDetail must align with ErrorOrigin.
59//
60//    If detail is present, it MUST correspond to the origin.
61//    Do not attach mismatched detail variants.
62//
63// 5. Plan-layer errors are NOT runtime failures.
64//
65//    PlanError and CursorPlanError must be translated into
66//    executor/query invariants via the canonical mapping functions.
67//    Do not leak plan-layer error types across execution boundaries.
68//
69// 6. Preserve taxonomy stability.
70//
71//    Do NOT:
72//      • Merge error classes.
73//      • Reclassify corruption as internal.
74//      • Downgrade invariant violations.
75//      • Introduce ambiguous class/origin combinations.
76//
77//    Any change to ErrorClass or ErrorOrigin is an architectural change
78//    and must be reviewed accordingly.
79//
80// -----------------------------------------------------------------------------
81// NON-GOALS
82// -----------------------------------------------------------------------------
83//
84// This is NOT:
85//
86//   • A public API contract.
87//   • A generic error abstraction layer.
88//   • A feature-specific message builder.
89//   • A dumping ground for temporary error conversions.
90//
91// -----------------------------------------------------------------------------
92// MAINTENANCE GUIDELINES
93// -----------------------------------------------------------------------------
94//
95// When modifying this file:
96//
97//   1. Ensure classification semantics remain consistent.
98//   2. Avoid constructor proliferation.
99//   3. Prefer narrow, origin-specific helpers over ad-hoc new(...).
100//   4. Keep formatting minimal and standardized.
101//   5. Keep this file boring and stable.
102//
103// If this file grows rapidly, something is wrong at the call sites.
104//
105// ============================================================================
106
107///
108/// InternalError
109///
110/// Structured runtime error with a stable internal classification.
111/// Not a stable API; intended for internal use and may change without notice.
112///
113
114#[derive(Debug, ThisError)]
115#[error("{message}")]
116pub struct InternalError {
117    pub(crate) class: ErrorClass,
118    pub(crate) origin: ErrorOrigin,
119    pub(crate) message: String,
120
121    /// Optional structured error detail.
122    /// The variant (if present) must correspond to `origin`.
123    pub(crate) detail: Option<ErrorDetail>,
124}
125
126impl InternalError {
127    /// Construct an InternalError with optional origin-specific detail.
128    /// This constructor provides default StoreError details for certain
129    /// (class, origin) combinations but does not guarantee a detail payload.
130    #[cold]
131    #[inline(never)]
132    pub fn new(class: ErrorClass, origin: ErrorOrigin, message: impl Into<String>) -> Self {
133        let message = message.into();
134
135        let detail = match (class, origin) {
136            (ErrorClass::Corruption, ErrorOrigin::Store) => {
137                Some(ErrorDetail::Store(StoreError::Corrupt {
138                    message: message.clone(),
139                }))
140            }
141            (ErrorClass::InvariantViolation, ErrorOrigin::Store) => {
142                Some(ErrorDetail::Store(StoreError::InvariantViolation {
143                    message: message.clone(),
144                }))
145            }
146            _ => None,
147        };
148
149        Self {
150            class,
151            origin,
152            message,
153            detail,
154        }
155    }
156
157    /// Return the internal error class taxonomy.
158    #[must_use]
159    pub const fn class(&self) -> ErrorClass {
160        self.class
161    }
162
163    /// Return the internal error origin taxonomy.
164    #[must_use]
165    pub const fn origin(&self) -> ErrorOrigin {
166        self.origin
167    }
168
169    /// Return the rendered internal error message.
170    #[must_use]
171    pub fn message(&self) -> &str {
172        &self.message
173    }
174
175    /// Return the optional structured detail payload.
176    #[must_use]
177    pub const fn detail(&self) -> Option<&ErrorDetail> {
178        self.detail.as_ref()
179    }
180
181    /// Consume and return the rendered internal error message.
182    #[must_use]
183    pub fn into_message(self) -> String {
184        self.message
185    }
186
187    /// Construct an error while preserving an explicit class/origin taxonomy pair.
188    #[cold]
189    #[inline(never)]
190    pub(crate) fn classified(
191        class: ErrorClass,
192        origin: ErrorOrigin,
193        message: impl Into<String>,
194    ) -> Self {
195        Self::new(class, origin, message)
196    }
197
198    /// Rebuild this error with a new message while preserving class/origin taxonomy.
199    #[cold]
200    #[inline(never)]
201    pub(crate) fn with_message(self, message: impl Into<String>) -> Self {
202        Self::classified(self.class, self.origin, message)
203    }
204
205    /// Rebuild this error with a new origin while preserving class/message.
206    ///
207    /// Origin-scoped detail payloads are intentionally dropped when re-origining.
208    #[cold]
209    #[inline(never)]
210    pub(crate) fn with_origin(self, origin: ErrorOrigin) -> Self {
211        Self::classified(self.class, origin, self.message)
212    }
213
214    /// Construct an index-origin invariant violation.
215    #[cold]
216    #[inline(never)]
217    pub(crate) fn index_invariant(message: impl Into<String>) -> Self {
218        Self::new(
219            ErrorClass::InvariantViolation,
220            ErrorOrigin::Index,
221            message.into(),
222        )
223    }
224
225    /// Construct the canonical index field-count invariant for key building.
226    pub(crate) fn index_key_field_count_exceeds_max(
227        index_name: &str,
228        field_count: usize,
229        max_fields: usize,
230    ) -> Self {
231        Self::index_invariant(format!(
232            "index '{index_name}' has {field_count} fields (max {max_fields})",
233        ))
234    }
235
236    /// Construct the canonical index-key source-field-missing-on-model invariant.
237    pub(crate) fn index_key_item_field_missing_on_entity_model(field: &str) -> Self {
238        Self::index_invariant(format!(
239            "index key item field missing on entity model: {field}",
240        ))
241    }
242
243    /// Construct the canonical index-key source-field-missing-on-row invariant.
244    pub(crate) fn index_key_item_field_missing_on_lookup_row(field: &str) -> Self {
245        Self::index_invariant(format!(
246            "index key item field missing on lookup row: {field}",
247        ))
248    }
249
250    /// Construct the canonical index-expression source-type mismatch invariant.
251    pub(crate) fn index_expression_source_type_mismatch(
252        index_name: &str,
253        expression: impl fmt::Display,
254        expected: &str,
255        source_label: &str,
256    ) -> Self {
257        Self::index_invariant(format!(
258            "index '{index_name}' expression '{expression}' expected {expected} source value, got {source_label}",
259        ))
260    }
261
262    /// Construct a planner-origin invariant violation with the canonical
263    /// executor-boundary invariant prefix preserved in the message payload.
264    #[cold]
265    #[inline(never)]
266    pub(crate) fn planner_executor_invariant(reason: impl Into<String>) -> Self {
267        Self::new(
268            ErrorClass::InvariantViolation,
269            ErrorOrigin::Planner,
270            Self::executor_invariant_message(reason),
271        )
272    }
273
274    /// Construct a query-origin invariant violation with the canonical
275    /// executor-boundary invariant prefix preserved in the message payload.
276    #[cold]
277    #[inline(never)]
278    pub(crate) fn query_executor_invariant(reason: impl Into<String>) -> Self {
279        Self::new(
280            ErrorClass::InvariantViolation,
281            ErrorOrigin::Query,
282            Self::executor_invariant_message(reason),
283        )
284    }
285
286    /// Construct a cursor-origin invariant violation with the canonical
287    /// executor-boundary invariant prefix preserved in the message payload.
288    #[cold]
289    #[inline(never)]
290    pub(crate) fn cursor_executor_invariant(reason: impl Into<String>) -> Self {
291        Self::new(
292            ErrorClass::InvariantViolation,
293            ErrorOrigin::Cursor,
294            Self::executor_invariant_message(reason),
295        )
296    }
297
298    /// Construct an executor-origin invariant violation.
299    #[cold]
300    #[inline(never)]
301    pub(crate) fn executor_invariant(message: impl Into<String>) -> Self {
302        Self::new(
303            ErrorClass::InvariantViolation,
304            ErrorOrigin::Executor,
305            message.into(),
306        )
307    }
308
309    /// Construct an executor-origin internal error.
310    #[cold]
311    #[inline(never)]
312    pub(crate) fn executor_internal(message: impl Into<String>) -> Self {
313        Self::new(ErrorClass::Internal, ErrorOrigin::Executor, message.into())
314    }
315
316    /// Construct an executor-origin unsupported error.
317    #[cold]
318    #[inline(never)]
319    pub(crate) fn executor_unsupported(message: impl Into<String>) -> Self {
320        Self::new(
321            ErrorClass::Unsupported,
322            ErrorOrigin::Executor,
323            message.into(),
324        )
325    }
326
327    /// Construct an executor-origin save-preflight primary-key missing invariant.
328    pub(crate) fn mutation_entity_primary_key_missing(entity_path: &str, field_name: &str) -> Self {
329        Self::executor_invariant(format!(
330            "entity primary key field missing: {entity_path} field={field_name}",
331        ))
332    }
333
334    /// Construct an executor-origin save-preflight primary-key invalid-value invariant.
335    pub(crate) fn mutation_entity_primary_key_invalid_value(
336        entity_path: &str,
337        field_name: &str,
338        value: &crate::value::Value,
339    ) -> Self {
340        Self::executor_invariant(format!(
341            "entity primary key field has invalid value: {entity_path} field={field_name} value={value:?}",
342        ))
343    }
344
345    /// Construct an executor-origin save-preflight primary-key type mismatch invariant.
346    pub(crate) fn mutation_entity_primary_key_type_mismatch(
347        entity_path: &str,
348        field_name: &str,
349        value: &crate::value::Value,
350    ) -> Self {
351        Self::executor_invariant(format!(
352            "entity primary key field type mismatch: {entity_path} field={field_name} value={value:?}",
353        ))
354    }
355
356    /// Construct an executor-origin save-preflight primary-key identity mismatch invariant.
357    pub(crate) fn mutation_entity_primary_key_mismatch(
358        entity_path: &str,
359        field_name: &str,
360        field_value: &crate::value::Value,
361        identity_key: &crate::value::Value,
362    ) -> Self {
363        Self::executor_invariant(format!(
364            "entity primary key mismatch: {entity_path} field={field_name} field_value={field_value:?} id_key={identity_key:?}",
365        ))
366    }
367
368    /// Construct an executor-origin save-preflight field-missing invariant.
369    pub(crate) fn mutation_entity_field_missing(
370        entity_path: &str,
371        field_name: &str,
372        indexed: bool,
373    ) -> Self {
374        let indexed_note = if indexed { " (indexed)" } else { "" };
375
376        Self::executor_invariant(format!(
377            "entity field missing: {entity_path} field={field_name}{indexed_note}",
378        ))
379    }
380
381    /// Construct an executor-origin save-preflight field-type mismatch invariant.
382    pub(crate) fn mutation_entity_field_type_mismatch(
383        entity_path: &str,
384        field_name: &str,
385        value: &crate::value::Value,
386    ) -> Self {
387        Self::executor_invariant(format!(
388            "entity field type mismatch: {entity_path} field={field_name} value={value:?}",
389        ))
390    }
391
392    /// Construct an executor-origin generated-field authored-write rejection.
393    pub(crate) fn mutation_generated_field_explicit(entity_path: &str, field_name: &str) -> Self {
394        Self::executor_unsupported(format!(
395            "generated field may not be explicitly written: {entity_path} field={field_name}",
396        ))
397    }
398
399    /// Construct an executor-origin typed create omission rejection.
400    pub(crate) fn mutation_create_missing_authored_fields(
401        entity_path: &str,
402        field_names: &str,
403    ) -> Self {
404        Self::executor_unsupported(format!(
405            "create requires explicit values for authorable fields {field_names}: {entity_path}",
406        ))
407    }
408
409    /// Construct an executor-origin mutation result invariant.
410    ///
411    /// This constructor lands ahead of the public structural mutation surface,
412    /// so the library target may not route through it until that caller exists.
413    pub(crate) fn mutation_structural_after_image_invalid(
414        entity_path: &str,
415        data_key: impl fmt::Display,
416        detail: impl AsRef<str>,
417    ) -> Self {
418        Self::executor_invariant(format!(
419            "mutation result is invalid: {entity_path} key={data_key} ({})",
420            detail.as_ref(),
421        ))
422    }
423
424    /// Construct an executor-origin mutation unknown-field invariant.
425    pub(crate) fn mutation_structural_field_unknown(entity_path: &str, field_name: &str) -> Self {
426        Self::executor_invariant(format!(
427            "mutation field not found: {entity_path} field={field_name}",
428        ))
429    }
430
431    /// Construct an executor-origin save-preflight decimal-scale unsupported error.
432    pub(crate) fn mutation_decimal_scale_mismatch(
433        entity_path: &str,
434        field_name: &str,
435        expected_scale: impl fmt::Display,
436        actual_scale: impl fmt::Display,
437    ) -> Self {
438        Self::executor_unsupported(format!(
439            "decimal field scale mismatch: {entity_path} field={field_name} expected_scale={expected_scale} actual_scale={actual_scale}",
440        ))
441    }
442
443    /// Construct an executor-origin save-preflight set-encoding invariant.
444    pub(crate) fn mutation_set_field_list_required(entity_path: &str, field_name: &str) -> Self {
445        Self::executor_invariant(format!(
446            "set field must encode as Value::List: {entity_path} field={field_name}",
447        ))
448    }
449
450    /// Construct an executor-origin save-preflight set-canonicality invariant.
451    pub(crate) fn mutation_set_field_not_canonical(entity_path: &str, field_name: &str) -> Self {
452        Self::executor_invariant(format!(
453            "set field must be strictly ordered and deduplicated: {entity_path} field={field_name}",
454        ))
455    }
456
457    /// Construct an executor-origin save-preflight map-encoding invariant.
458    pub(crate) fn mutation_map_field_map_required(entity_path: &str, field_name: &str) -> Self {
459        Self::executor_invariant(format!(
460            "map field must encode as Value::Map: {entity_path} field={field_name}",
461        ))
462    }
463
464    /// Construct an executor-origin save-preflight map-entry invariant.
465    pub(crate) fn mutation_map_field_entries_invalid(
466        entity_path: &str,
467        field_name: &str,
468        detail: impl fmt::Display,
469    ) -> Self {
470        Self::executor_invariant(format!(
471            "map field entries violate map invariants: {entity_path} field={field_name} ({detail})",
472        ))
473    }
474
475    /// Construct an executor-origin save-preflight map-canonicality invariant.
476    pub(crate) fn mutation_map_field_entries_not_canonical(
477        entity_path: &str,
478        field_name: &str,
479    ) -> Self {
480        Self::executor_invariant(format!(
481            "map field entries are not in canonical deterministic order: {entity_path} field={field_name}",
482        ))
483    }
484
485    /// Construct a query-origin scalar page invariant for ordering before filtering.
486    pub(crate) fn scalar_page_ordering_after_filtering_required() -> Self {
487        Self::query_executor_invariant("ordering must run after filtering")
488    }
489
490    /// Construct a query-origin scalar page invariant for missing order at the cursor boundary.
491    pub(crate) fn scalar_page_cursor_boundary_order_required() -> Self {
492        Self::query_executor_invariant("cursor boundary requires ordering")
493    }
494
495    /// Construct a query-origin scalar page invariant for cursor-before-ordering drift.
496    pub(crate) fn scalar_page_cursor_boundary_after_ordering_required() -> Self {
497        Self::query_executor_invariant("cursor boundary must run after ordering")
498    }
499
500    /// Construct a query-origin scalar page invariant for pagination-before-ordering drift.
501    pub(crate) fn scalar_page_pagination_after_ordering_required() -> Self {
502        Self::query_executor_invariant("pagination must run after ordering")
503    }
504
505    /// Construct a query-origin scalar page invariant for delete-limit-before-ordering drift.
506    pub(crate) fn scalar_page_delete_limit_after_ordering_required() -> Self {
507        Self::query_executor_invariant("delete limit must run after ordering")
508    }
509
510    /// Construct a query-origin load-runtime invariant for scalar-mode payload mismatch.
511    pub(crate) fn load_runtime_scalar_payload_required() -> Self {
512        Self::query_executor_invariant("scalar load mode must carry scalar runtime payload")
513    }
514
515    /// Construct a query-origin load-runtime invariant for grouped-mode payload mismatch.
516    pub(crate) fn load_runtime_grouped_payload_required() -> Self {
517        Self::query_executor_invariant("grouped load mode must carry grouped runtime payload")
518    }
519
520    /// Construct a query-origin load-surface invariant for scalar-page payload mismatch.
521    pub(crate) fn load_runtime_scalar_surface_payload_required() -> Self {
522        Self::query_executor_invariant("scalar page load mode must carry scalar runtime payload")
523    }
524
525    /// Construct a query-origin load-surface invariant for grouped-page payload mismatch.
526    pub(crate) fn load_runtime_grouped_surface_payload_required() -> Self {
527        Self::query_executor_invariant("grouped page load mode must carry grouped runtime payload")
528    }
529
530    /// Construct a query-origin load-entrypoint invariant for non-load plans.
531    pub(crate) fn load_executor_load_plan_required() -> Self {
532        Self::query_executor_invariant("load executor requires load plans")
533    }
534
535    /// Construct an executor-origin delete-entrypoint unsupported grouped-mode error.
536    pub(crate) fn delete_executor_grouped_unsupported() -> Self {
537        Self::executor_unsupported("grouped query execution is not yet enabled in this release")
538    }
539
540    /// Construct a query-origin delete-entrypoint invariant for non-delete plans.
541    pub(crate) fn delete_executor_delete_plan_required() -> Self {
542        Self::query_executor_invariant("delete executor requires delete plans")
543    }
544
545    /// Construct a query-origin aggregate kernel invariant for fold-mode contract drift.
546    pub(crate) fn aggregate_fold_mode_terminal_contract_required() -> Self {
547        Self::query_executor_invariant(
548            "aggregate fold mode must match route fold-mode contract for aggregate terminal",
549        )
550    }
551
552    /// Construct a query-origin fast-stream invariant for missing exact key-count observability.
553    pub(crate) fn fast_stream_exact_key_count_required() -> Self {
554        Self::query_executor_invariant("fast-path stream must expose an exact key-count hint")
555    }
556
557    /// Construct a query-origin fast-stream invariant for route kind/request mismatch.
558    pub(crate) fn fast_stream_route_kind_request_match_required() -> Self {
559        Self::query_executor_invariant("fast-stream route kind/request mismatch")
560    }
561
562    /// Construct a query-origin scan invariant for missing index-prefix executable specs.
563    pub(crate) fn secondary_index_prefix_spec_required() -> Self {
564        Self::query_executor_invariant(
565            "index-prefix executable spec must be materialized for index-prefix plans",
566        )
567    }
568
569    /// Construct a query-origin scan invariant for missing index-range executable specs.
570    pub(crate) fn index_range_limit_spec_required() -> Self {
571        Self::query_executor_invariant(
572            "index-range executable spec must be materialized for index-range plans",
573        )
574    }
575
576    /// Construct an executor-origin mutation unsupported error for duplicate atomic save keys.
577    pub(crate) fn mutation_atomic_save_duplicate_key(
578        entity_path: &str,
579        key: impl fmt::Display,
580    ) -> Self {
581        Self::executor_unsupported(format!(
582            "atomic save batch rejected duplicate key: entity={entity_path} key={key}",
583        ))
584    }
585
586    /// Construct an executor-origin mutation invariant for index-store generation drift.
587    pub(crate) fn mutation_index_store_generation_changed(
588        expected_generation: u64,
589        observed_generation: u64,
590    ) -> Self {
591        Self::executor_invariant(format!(
592            "index store generation changed between preflight and apply: expected {expected_generation}, found {observed_generation}",
593        ))
594    }
595
596    /// Build the canonical executor-invariant message prefix.
597    #[must_use]
598    #[cold]
599    #[inline(never)]
600    pub(crate) fn executor_invariant_message(reason: impl Into<String>) -> String {
601        format!("executor invariant violated: {}", reason.into())
602    }
603
604    /// Construct a planner-origin invariant violation.
605    #[cold]
606    #[inline(never)]
607    pub(crate) fn planner_invariant(message: impl Into<String>) -> Self {
608        Self::new(
609            ErrorClass::InvariantViolation,
610            ErrorOrigin::Planner,
611            message.into(),
612        )
613    }
614
615    /// Build the canonical invalid-logical-plan message prefix.
616    #[must_use]
617    pub(crate) fn invalid_logical_plan_message(reason: impl Into<String>) -> String {
618        format!("invalid logical plan: {}", reason.into())
619    }
620
621    /// Construct a planner-origin invariant with the canonical invalid-plan prefix.
622    pub(crate) fn query_invalid_logical_plan(reason: impl Into<String>) -> Self {
623        Self::planner_invariant(Self::invalid_logical_plan_message(reason))
624    }
625
626    /// Construct a query-origin invariant violation.
627    #[cold]
628    #[inline(never)]
629    pub(crate) fn query_invariant(message: impl Into<String>) -> Self {
630        Self::new(
631            ErrorClass::InvariantViolation,
632            ErrorOrigin::Query,
633            message.into(),
634        )
635    }
636
637    /// Construct a store-origin invariant violation.
638    pub(crate) fn store_invariant(message: impl Into<String>) -> Self {
639        Self::new(
640            ErrorClass::InvariantViolation,
641            ErrorOrigin::Store,
642            message.into(),
643        )
644    }
645
646    /// Construct the canonical duplicate runtime-hook entity-tag invariant.
647    pub(crate) fn duplicate_runtime_hooks_for_entity_tag(
648        entity_tag: crate::types::EntityTag,
649    ) -> Self {
650        Self::store_invariant(format!(
651            "duplicate runtime hooks for entity tag '{}'",
652            entity_tag.value()
653        ))
654    }
655
656    /// Construct the canonical duplicate runtime-hook entity-path invariant.
657    pub(crate) fn duplicate_runtime_hooks_for_entity_path(entity_path: &str) -> Self {
658        Self::store_invariant(format!(
659            "duplicate runtime hooks for entity path '{entity_path}'"
660        ))
661    }
662
663    /// Construct a store-origin internal error.
664    #[cold]
665    #[inline(never)]
666    pub(crate) fn store_internal(message: impl Into<String>) -> Self {
667        Self::new(ErrorClass::Internal, ErrorOrigin::Store, message.into())
668    }
669
670    /// Construct the canonical unconfigured commit-memory id internal error.
671    pub(crate) fn commit_memory_id_unconfigured() -> Self {
672        Self::store_internal(
673            "commit memory id is not configured; initialize recovery before commit store access",
674        )
675    }
676
677    /// Construct the canonical commit-memory id mismatch internal error.
678    pub(crate) fn commit_memory_id_mismatch(cached_id: u8, configured_id: u8) -> Self {
679        Self::store_internal(format!(
680            "commit memory id mismatch: cached={cached_id}, configured={configured_id}",
681        ))
682    }
683
684    /// Construct the canonical missing rollback-row invariant for delete execution.
685    pub(crate) fn delete_rollback_row_required() -> Self {
686        Self::store_internal("missing raw row for delete rollback")
687    }
688
689    /// Construct the canonical memory-registry initialization failure for commit memory.
690    pub(crate) fn commit_memory_registry_init_failed(err: impl fmt::Display) -> Self {
691        Self::store_internal(format!("memory registry init failed: {err}"))
692    }
693
694    /// Construct the canonical migration cursor persistence-width internal error.
695    pub(crate) fn migration_next_step_index_u64_required(id: &str, version: u64) -> Self {
696        Self::store_internal(format!(
697            "migration '{id}@{version}' next step index does not fit persisted u64 cursor",
698        ))
699    }
700
701    /// Construct the canonical recovery-integrity totals corruption error.
702    pub(crate) fn recovery_integrity_validation_failed(
703        missing_index_entries: u64,
704        divergent_index_entries: u64,
705        orphan_index_references: u64,
706    ) -> Self {
707        Self::store_corruption(format!(
708            "recovery integrity validation failed: missing_index_entries={missing_index_entries} divergent_index_entries={divergent_index_entries} orphan_index_references={orphan_index_references}",
709        ))
710    }
711
712    /// Construct an index-origin internal error.
713    #[cold]
714    #[inline(never)]
715    pub(crate) fn index_internal(message: impl Into<String>) -> Self {
716        Self::new(ErrorClass::Internal, ErrorOrigin::Index, message.into())
717    }
718
719    /// Construct the canonical missing old entity-key internal error for structural index removal.
720    pub(crate) fn structural_index_removal_entity_key_required() -> Self {
721        Self::index_internal("missing old entity key for structural index removal")
722    }
723
724    /// Construct the canonical missing new entity-key internal error for structural index insertion.
725    pub(crate) fn structural_index_insertion_entity_key_required() -> Self {
726        Self::index_internal("missing new entity key for structural index insertion")
727    }
728
729    /// Construct the canonical missing old entity-key internal error for index commit-op removal.
730    pub(crate) fn index_commit_op_old_entity_key_required() -> Self {
731        Self::index_internal("missing old entity key for index removal")
732    }
733
734    /// Construct the canonical missing new entity-key internal error for index commit-op insertion.
735    pub(crate) fn index_commit_op_new_entity_key_required() -> Self {
736        Self::index_internal("missing new entity key for index insertion")
737    }
738
739    /// Construct a query-origin internal error.
740    #[cfg(test)]
741    pub(crate) fn query_internal(message: impl Into<String>) -> Self {
742        Self::new(ErrorClass::Internal, ErrorOrigin::Query, message.into())
743    }
744
745    /// Construct a query-origin unsupported error.
746    #[cold]
747    #[inline(never)]
748    pub(crate) fn query_unsupported(message: impl Into<String>) -> Self {
749        Self::new(ErrorClass::Unsupported, ErrorOrigin::Query, message.into())
750    }
751
752    /// Construct a serialize-origin internal error.
753    #[cold]
754    #[inline(never)]
755    pub(crate) fn serialize_internal(message: impl Into<String>) -> Self {
756        Self::new(ErrorClass::Internal, ErrorOrigin::Serialize, message.into())
757    }
758
759    /// Construct the canonical persisted-row encode internal error.
760    pub(crate) fn persisted_row_encode_failed(detail: impl fmt::Display) -> Self {
761        Self::serialize_internal(format!("row encode failed: {detail}"))
762    }
763
764    /// Construct the canonical persisted-row field encode internal error.
765    pub(crate) fn persisted_row_field_encode_failed(
766        field_name: &str,
767        detail: impl fmt::Display,
768    ) -> Self {
769        Self::serialize_internal(format!(
770            "row encode failed for field '{field_name}': {detail}",
771        ))
772    }
773
774    /// Construct the canonical bytes(field) value encode internal error.
775    pub(crate) fn bytes_field_value_encode_failed(detail: impl fmt::Display) -> Self {
776        Self::serialize_internal(format!("bytes(field) value encode failed: {detail}"))
777    }
778
779    /// Construct the canonical migration-state serialization failure.
780    pub(crate) fn migration_state_serialize_failed(err: impl fmt::Display) -> Self {
781        Self::serialize_internal(format!("failed to serialize migration state: {err}"))
782    }
783
784    /// Construct a store-origin corruption error.
785    #[cold]
786    #[inline(never)]
787    pub(crate) fn store_corruption(message: impl Into<String>) -> Self {
788        Self::new(ErrorClass::Corruption, ErrorOrigin::Store, message.into())
789    }
790
791    /// Construct the canonical multiple-commit-memory-ids corruption error.
792    pub(crate) fn multiple_commit_memory_ids_registered(ids: impl fmt::Debug) -> Self {
793        Self::store_corruption(format!(
794            "multiple commit marker memory ids registered: {ids:?}"
795        ))
796    }
797
798    /// Construct the canonical persisted migration-step index conversion corruption error.
799    pub(crate) fn migration_persisted_step_index_invalid_usize(
800        id: &str,
801        version: u64,
802        step_index: u64,
803    ) -> Self {
804        Self::store_corruption(format!(
805            "migration '{id}@{version}' persisted step index does not fit runtime usize: {step_index}",
806        ))
807    }
808
809    /// Construct the canonical persisted migration-step index bounds corruption error.
810    pub(crate) fn migration_persisted_step_index_out_of_bounds(
811        id: &str,
812        version: u64,
813        step_index: usize,
814        total_steps: usize,
815    ) -> Self {
816        Self::store_corruption(format!(
817            "migration '{id}@{version}' persisted step index out of bounds: {step_index} > {total_steps}",
818        ))
819    }
820
821    /// Construct a store-origin commit-marker corruption error.
822    pub(crate) fn commit_corruption(detail: impl fmt::Display) -> Self {
823        Self::store_corruption(format!("commit marker corrupted: {detail}"))
824    }
825
826    /// Construct a store-origin commit-marker component corruption error.
827    pub(crate) fn commit_component_corruption(component: &str, detail: impl fmt::Display) -> Self {
828        Self::store_corruption(format!("commit marker {component} corrupted: {detail}"))
829    }
830
831    /// Construct the canonical commit-marker id generation internal error.
832    pub(crate) fn commit_id_generation_failed(detail: impl fmt::Display) -> Self {
833        Self::store_internal(format!("commit id generation failed: {detail}"))
834    }
835
836    /// Construct the canonical commit-marker payload u32-length-limit error.
837    pub(crate) fn commit_marker_payload_exceeds_u32_length_limit(label: &str, len: usize) -> Self {
838        Self::store_unsupported(format!("{label} exceeds u32 length limit: {len} bytes"))
839    }
840
841    /// Construct the canonical commit-marker component invalid-length corruption error.
842    pub(crate) fn commit_component_length_invalid(
843        component: &str,
844        len: usize,
845        expected: impl fmt::Display,
846    ) -> Self {
847        Self::commit_component_corruption(
848            component,
849            format!("invalid length {len}, expected {expected}"),
850        )
851    }
852
853    /// Construct the canonical commit-marker max-size corruption error.
854    pub(crate) fn commit_marker_exceeds_max_size(size: usize, max_size: u32) -> Self {
855        Self::commit_corruption(format!(
856            "commit marker exceeds max size: {size} bytes (limit {max_size})",
857        ))
858    }
859
860    /// Construct the canonical pre-persist commit-marker max-size unsupported error.
861    #[cfg(test)]
862    pub(crate) fn commit_marker_exceeds_max_size_before_persist(
863        size: usize,
864        max_size: u32,
865    ) -> Self {
866        Self::store_unsupported(format!(
867            "commit marker exceeds max size: {size} bytes (limit {max_size})",
868        ))
869    }
870
871    /// Construct the canonical commit-control slot max-size unsupported error.
872    pub(crate) fn commit_control_slot_exceeds_max_size(size: usize, max_size: u32) -> Self {
873        Self::store_unsupported(format!(
874            "commit control slot exceeds max size: {size} bytes (limit {max_size})",
875        ))
876    }
877
878    /// Construct the canonical commit-control marker-bytes length-limit error.
879    pub(crate) fn commit_control_slot_marker_bytes_exceed_u32_length_limit(size: usize) -> Self {
880        Self::store_unsupported(format!(
881            "commit marker bytes exceed u32 length limit: {size} bytes",
882        ))
883    }
884
885    /// Construct the canonical commit-control migration-bytes length-limit error.
886    pub(crate) fn commit_control_slot_migration_bytes_exceed_u32_length_limit(size: usize) -> Self {
887        Self::store_unsupported(format!(
888            "commit migration bytes exceed u32 length limit: {size} bytes",
889        ))
890    }
891
892    /// Construct the canonical startup index-rebuild invalid-data-key corruption error.
893    pub(crate) fn startup_index_rebuild_invalid_data_key(
894        store_path: &str,
895        detail: impl fmt::Display,
896    ) -> Self {
897        Self::store_corruption(format!(
898            "startup index rebuild failed: invalid data key in store '{store_path}' ({detail})",
899        ))
900    }
901
902    /// Construct an index-origin corruption error.
903    #[cold]
904    #[inline(never)]
905    pub(crate) fn index_corruption(message: impl Into<String>) -> Self {
906        Self::new(ErrorClass::Corruption, ErrorOrigin::Index, message.into())
907    }
908
909    /// Construct the canonical unique-validation corruption wrapper.
910    pub(crate) fn index_unique_validation_corruption(
911        entity_path: &str,
912        fields: &str,
913        detail: impl fmt::Display,
914    ) -> Self {
915        Self::index_plan_index_corruption(format!(
916            "index corrupted: {entity_path} ({fields}) -> {detail}",
917        ))
918    }
919
920    /// Construct the canonical structural index-entry corruption wrapper.
921    pub(crate) fn structural_index_entry_corruption(
922        entity_path: &str,
923        fields: &str,
924        detail: impl fmt::Display,
925    ) -> Self {
926        Self::index_plan_index_corruption(format!(
927            "index corrupted: {entity_path} ({fields}) -> {detail}",
928        ))
929    }
930
931    /// Construct the canonical missing new entity-key invariant during unique validation.
932    pub(crate) fn index_unique_validation_entity_key_required() -> Self {
933        Self::index_invariant("missing entity key during unique validation")
934    }
935
936    /// Construct the canonical unique-validation structural row-decode corruption error.
937    pub(crate) fn index_unique_validation_row_deserialize_failed(
938        data_key: impl fmt::Display,
939        source: impl fmt::Display,
940    ) -> Self {
941        Self::index_plan_serialize_corruption(format!(
942            "failed to structurally deserialize row: {data_key} ({source})"
943        ))
944    }
945
946    /// Construct the canonical unique-validation primary-key slot decode corruption error.
947    pub(crate) fn index_unique_validation_primary_key_decode_failed(
948        data_key: impl fmt::Display,
949        source: impl fmt::Display,
950    ) -> Self {
951        Self::index_plan_serialize_corruption(format!(
952            "failed to decode structural primary-key slot: {data_key} ({source})"
953        ))
954    }
955
956    /// Construct the canonical unique-validation stored key rebuild corruption error.
957    pub(crate) fn index_unique_validation_key_rebuild_failed(
958        data_key: impl fmt::Display,
959        entity_path: &str,
960        source: impl fmt::Display,
961    ) -> Self {
962        Self::index_plan_serialize_corruption(format!(
963            "failed to structurally decode unique key row {data_key} for {entity_path}: {source}",
964        ))
965    }
966
967    /// Construct the canonical unique-validation missing-row corruption error.
968    pub(crate) fn index_unique_validation_row_required(data_key: impl fmt::Display) -> Self {
969        Self::index_plan_store_corruption(format!("missing row: {data_key}"))
970    }
971
972    /// Construct the canonical index-only predicate missing-component invariant.
973    pub(crate) fn index_only_predicate_component_required() -> Self {
974        Self::index_invariant("index-only predicate program referenced missing index component")
975    }
976
977    /// Construct the canonical index-scan continuation-envelope invariant.
978    pub(crate) fn index_scan_continuation_anchor_within_envelope_required() -> Self {
979        Self::index_invariant(
980            "index-range continuation anchor is outside the requested range envelope",
981        )
982    }
983
984    /// Construct the canonical index-scan continuation-advancement invariant.
985    pub(crate) fn index_scan_continuation_advancement_required() -> Self {
986        Self::index_invariant("index-range continuation scan did not advance beyond the anchor")
987    }
988
989    /// Construct the canonical index-scan key-decode corruption error.
990    pub(crate) fn index_scan_key_corrupted_during(
991        context: &'static str,
992        err: impl fmt::Display,
993    ) -> Self {
994        Self::index_corruption(format!("index key corrupted during {context}: {err}"))
995    }
996
997    /// Construct the canonical index-scan missing projection-component invariant.
998    pub(crate) fn index_projection_component_required(
999        index_name: &str,
1000        component_index: usize,
1001    ) -> Self {
1002        Self::index_invariant(format!(
1003            "index projection referenced missing component: index='{index_name}' component_index={component_index}",
1004        ))
1005    }
1006
1007    /// Construct the canonical unexpected unique index-entry cardinality corruption error.
1008    pub(crate) fn unique_index_entry_single_key_required() -> Self {
1009        Self::index_corruption("unique index entry contains an unexpected number of keys")
1010    }
1011
1012    /// Construct the canonical scan-time index-entry decode corruption error.
1013    pub(crate) fn index_entry_decode_failed(err: impl fmt::Display) -> Self {
1014        Self::index_corruption(err.to_string())
1015    }
1016
1017    /// Construct a serialize-origin corruption error.
1018    pub(crate) fn serialize_corruption(message: impl Into<String>) -> Self {
1019        Self::new(
1020            ErrorClass::Corruption,
1021            ErrorOrigin::Serialize,
1022            message.into(),
1023        )
1024    }
1025
1026    /// Construct the canonical persisted-row decode corruption error.
1027    pub(crate) fn persisted_row_decode_failed(detail: impl fmt::Display) -> Self {
1028        Self::serialize_corruption(format!("row decode: {detail}"))
1029    }
1030
1031    /// Construct the canonical persisted-row field decode corruption error.
1032    pub(crate) fn persisted_row_field_decode_failed(
1033        field_name: &str,
1034        detail: impl fmt::Display,
1035    ) -> Self {
1036        Self::serialize_corruption(format!(
1037            "row decode failed for field '{field_name}': {detail}",
1038        ))
1039    }
1040
1041    /// Construct the canonical persisted-row field-kind decode corruption error.
1042    pub(crate) fn persisted_row_field_kind_decode_failed(
1043        field_name: &str,
1044        field_kind: impl fmt::Debug,
1045        detail: impl fmt::Display,
1046    ) -> Self {
1047        Self::persisted_row_field_decode_failed(
1048            field_name,
1049            format!("kind={field_kind:?}: {detail}"),
1050        )
1051    }
1052
1053    /// Construct the canonical persisted-row scalar-payload length corruption error.
1054    pub(crate) fn persisted_row_field_payload_exact_len_required(
1055        field_name: &str,
1056        payload_kind: &str,
1057        expected_len: usize,
1058    ) -> Self {
1059        let unit = if expected_len == 1 { "byte" } else { "bytes" };
1060
1061        Self::persisted_row_field_decode_failed(
1062            field_name,
1063            format!("{payload_kind} payload must be exactly {expected_len} {unit}"),
1064        )
1065    }
1066
1067    /// Construct the canonical persisted-row scalar-payload empty-body corruption error.
1068    pub(crate) fn persisted_row_field_payload_must_be_empty(
1069        field_name: &str,
1070        payload_kind: &str,
1071    ) -> Self {
1072        Self::persisted_row_field_decode_failed(
1073            field_name,
1074            format!("{payload_kind} payload must be empty"),
1075        )
1076    }
1077
1078    /// Construct the canonical persisted-row scalar-payload invalid-byte corruption error.
1079    pub(crate) fn persisted_row_field_payload_invalid_byte(
1080        field_name: &str,
1081        payload_kind: &str,
1082        value: u8,
1083    ) -> Self {
1084        Self::persisted_row_field_decode_failed(
1085            field_name,
1086            format!("invalid {payload_kind} payload byte {value}"),
1087        )
1088    }
1089
1090    /// Construct the canonical persisted-row scalar-payload non-finite corruption error.
1091    pub(crate) fn persisted_row_field_payload_non_finite(
1092        field_name: &str,
1093        payload_kind: &str,
1094    ) -> Self {
1095        Self::persisted_row_field_decode_failed(
1096            field_name,
1097            format!("{payload_kind} payload is non-finite"),
1098        )
1099    }
1100
1101    /// Construct the canonical persisted-row scalar-payload out-of-range corruption error.
1102    pub(crate) fn persisted_row_field_payload_out_of_range(
1103        field_name: &str,
1104        payload_kind: &str,
1105    ) -> Self {
1106        Self::persisted_row_field_decode_failed(
1107            field_name,
1108            format!("{payload_kind} payload out of range for target type"),
1109        )
1110    }
1111
1112    /// Construct the canonical persisted-row invalid text payload corruption error.
1113    pub(crate) fn persisted_row_field_text_payload_invalid_utf8(
1114        field_name: &str,
1115        detail: impl fmt::Display,
1116    ) -> Self {
1117        Self::persisted_row_field_decode_failed(
1118            field_name,
1119            format!("invalid UTF-8 text payload ({detail})"),
1120        )
1121    }
1122
1123    /// Construct the canonical persisted-row structural slot-lookup invariant.
1124    pub(crate) fn persisted_row_slot_lookup_out_of_bounds(model_path: &str, slot: usize) -> Self {
1125        Self::index_invariant(format!(
1126            "slot lookup outside model bounds during structural row access: model='{model_path}' slot={slot}",
1127        ))
1128    }
1129
1130    /// Construct the canonical persisted-row structural slot-cache invariant.
1131    pub(crate) fn persisted_row_slot_cache_lookup_out_of_bounds(
1132        model_path: &str,
1133        slot: usize,
1134    ) -> Self {
1135        Self::index_invariant(format!(
1136            "slot cache lookup outside model bounds during structural row access: model='{model_path}' slot={slot}",
1137        ))
1138    }
1139
1140    /// Construct the canonical persisted-row primary-key decode corruption error.
1141    pub(crate) fn persisted_row_primary_key_not_storage_encodable(
1142        data_key: impl fmt::Debug,
1143        detail: impl fmt::Display,
1144    ) -> Self {
1145        Self::persisted_row_decode_failed(format!(
1146            "primary-key value is not storage-key encodable: {data_key:?} ({detail})",
1147        ))
1148    }
1149
1150    /// Construct the canonical persisted-row missing primary-key slot corruption error.
1151    pub(crate) fn persisted_row_primary_key_slot_missing(data_key: impl fmt::Debug) -> Self {
1152        Self::persisted_row_decode_failed(format!(
1153            "missing primary-key slot while validating {data_key:?}",
1154        ))
1155    }
1156
1157    /// Construct the canonical persisted-row key mismatch corruption error.
1158    pub(crate) fn persisted_row_key_mismatch(
1159        expected_key: impl fmt::Debug,
1160        found_key: impl fmt::Debug,
1161    ) -> Self {
1162        Self::store_corruption(format!(
1163            "row key mismatch: expected {expected_key:?}, found {found_key:?}",
1164        ))
1165    }
1166
1167    /// Construct the canonical persisted-row missing declared-field corruption error.
1168    pub(crate) fn persisted_row_declared_field_missing(field_name: &str) -> Self {
1169        Self::persisted_row_decode_failed(format!("missing declared field `{field_name}`"))
1170    }
1171
1172    /// Construct the canonical data-key entity mismatch corruption error.
1173    pub(crate) fn data_key_entity_mismatch(
1174        expected: impl fmt::Display,
1175        found: impl fmt::Display,
1176    ) -> Self {
1177        Self::store_corruption(format!(
1178            "data key entity mismatch: expected {expected}, found {found}",
1179        ))
1180    }
1181
1182    /// Construct the canonical data-key primary-key decode corruption error.
1183    pub(crate) fn data_key_primary_key_decode_failed(value: impl fmt::Debug) -> Self {
1184        Self::store_corruption(format!("data key primary key decode failed: {value:?}"))
1185    }
1186
1187    /// Construct the canonical reverse-index ordinal overflow internal error.
1188    pub(crate) fn reverse_index_ordinal_overflow(
1189        source_path: &str,
1190        field_name: &str,
1191        target_path: &str,
1192        detail: impl fmt::Display,
1193    ) -> Self {
1194        Self::index_internal(format!(
1195            "reverse index ordinal overflow: source={source_path} field={field_name} target={target_path} ({detail})",
1196        ))
1197    }
1198
1199    /// Construct the canonical reverse-index entry corruption error.
1200    pub(crate) fn reverse_index_entry_corrupted(
1201        source_path: &str,
1202        field_name: &str,
1203        target_path: &str,
1204        index_key: impl fmt::Debug,
1205        detail: impl fmt::Display,
1206    ) -> Self {
1207        Self::index_corruption(format!(
1208            "reverse index entry corrupted: source={source_path} field={field_name} target={target_path} key={index_key:?} ({detail})",
1209        ))
1210    }
1211
1212    /// Construct the canonical reverse-index entry encode unsupported error.
1213    pub(crate) fn reverse_index_entry_encode_failed(
1214        source_path: &str,
1215        field_name: &str,
1216        target_path: &str,
1217        detail: impl fmt::Display,
1218    ) -> Self {
1219        Self::index_unsupported(format!(
1220            "reverse index entry encoding failed: source={source_path} field={field_name} target={target_path} ({detail})",
1221        ))
1222    }
1223
1224    /// Construct the canonical relation-target store missing internal error.
1225    pub(crate) fn relation_target_store_missing(
1226        source_path: &str,
1227        field_name: &str,
1228        target_path: &str,
1229        store_path: &str,
1230        detail: impl fmt::Display,
1231    ) -> Self {
1232        Self::executor_internal(format!(
1233            "relation target store missing: source={source_path} field={field_name} target={target_path} store={store_path} ({detail})",
1234        ))
1235    }
1236
1237    /// Construct the canonical relation-target key decode corruption error.
1238    pub(crate) fn relation_target_key_decode_failed(
1239        context_label: &str,
1240        source_path: &str,
1241        field_name: &str,
1242        target_path: &str,
1243        detail: impl fmt::Display,
1244    ) -> Self {
1245        Self::identity_corruption(format!(
1246            "{context_label}: source={source_path} field={field_name} target={target_path} ({detail})",
1247        ))
1248    }
1249
1250    /// Construct the canonical relation-target entity mismatch corruption error.
1251    pub(crate) fn relation_target_entity_mismatch(
1252        context_label: &str,
1253        source_path: &str,
1254        field_name: &str,
1255        target_path: &str,
1256        target_entity_name: &str,
1257        expected_tag: impl fmt::Display,
1258        actual_tag: impl fmt::Display,
1259    ) -> Self {
1260        Self::store_corruption(format!(
1261            "{context_label}: source={source_path} field={field_name} target={target_path} expected={target_entity_name} (tag={expected_tag}) actual_tag={actual_tag}",
1262        ))
1263    }
1264
1265    /// Construct the canonical relation-source row decode corruption error.
1266    pub(crate) fn relation_source_row_decode_failed(
1267        source_path: &str,
1268        field_name: &str,
1269        target_path: &str,
1270        detail: impl fmt::Display,
1271    ) -> Self {
1272        Self::serialize_corruption(format!(
1273            "relation source row decode: source={source_path} field={field_name} target={target_path} ({detail})",
1274        ))
1275    }
1276
1277    /// Construct the canonical relation-source unsupported scalar relation-key corruption error.
1278    pub(crate) fn relation_source_row_unsupported_scalar_relation_key(
1279        source_path: &str,
1280        field_name: &str,
1281        target_path: &str,
1282    ) -> Self {
1283        Self::serialize_corruption(format!(
1284            "relation source row decode: unsupported scalar relation key: source={source_path} field={field_name} target={target_path}",
1285        ))
1286    }
1287
1288    /// Construct the canonical invalid strong-relation field-kind corruption error.
1289    pub(crate) fn relation_source_row_invalid_field_kind(field_kind: impl fmt::Debug) -> Self {
1290        Self::serialize_corruption(format!(
1291            "invalid strong relation field kind during structural decode: {field_kind:?}"
1292        ))
1293    }
1294
1295    /// Construct the canonical unsupported strong-relation key-kind corruption error.
1296    pub(crate) fn relation_source_row_unsupported_key_kind(field_kind: impl fmt::Debug) -> Self {
1297        Self::serialize_corruption(format!(
1298            "unsupported strong relation key kind during structural decode: {field_kind:?}"
1299        ))
1300    }
1301
1302    /// Construct the canonical reverse-index relation-target decode invariant failure.
1303    pub(crate) fn reverse_index_relation_target_decode_invariant_violated(
1304        source_path: &str,
1305        field_name: &str,
1306        target_path: &str,
1307    ) -> Self {
1308        Self::executor_internal(format!(
1309            "relation target decode invariant violated while preparing reverse index: source={source_path} field={field_name} target={target_path}",
1310        ))
1311    }
1312
1313    /// Construct the canonical covering-component empty-payload corruption error.
1314    pub(crate) fn bytes_covering_component_payload_empty() -> Self {
1315        Self::index_corruption("index component payload is empty during covering projection decode")
1316    }
1317
1318    /// Construct the canonical covering-component truncated bool corruption error.
1319    pub(crate) fn bytes_covering_bool_payload_truncated() -> Self {
1320        Self::index_corruption("bool covering component payload is truncated")
1321    }
1322
1323    /// Construct the canonical covering-component invalid-length corruption error.
1324    pub(crate) fn bytes_covering_component_payload_invalid_length(payload_kind: &str) -> Self {
1325        Self::index_corruption(format!(
1326            "{payload_kind} covering component payload has invalid length"
1327        ))
1328    }
1329
1330    /// Construct the canonical covering-component invalid-bool corruption error.
1331    pub(crate) fn bytes_covering_bool_payload_invalid_value() -> Self {
1332        Self::index_corruption("bool covering component payload has invalid value")
1333    }
1334
1335    /// Construct the canonical covering-component invalid text terminator corruption error.
1336    pub(crate) fn bytes_covering_text_payload_invalid_terminator() -> Self {
1337        Self::index_corruption("text covering component payload has invalid terminator")
1338    }
1339
1340    /// Construct the canonical covering-component trailing-text corruption error.
1341    pub(crate) fn bytes_covering_text_payload_trailing_bytes() -> Self {
1342        Self::index_corruption("text covering component payload contains trailing bytes")
1343    }
1344
1345    /// Construct the canonical covering-component invalid-UTF-8 text corruption error.
1346    pub(crate) fn bytes_covering_text_payload_invalid_utf8() -> Self {
1347        Self::index_corruption("text covering component payload is not valid UTF-8")
1348    }
1349
1350    /// Construct the canonical covering-component invalid text escape corruption error.
1351    pub(crate) fn bytes_covering_text_payload_invalid_escape_byte() -> Self {
1352        Self::index_corruption("text covering component payload has invalid escape byte")
1353    }
1354
1355    /// Construct the canonical covering-component missing text terminator corruption error.
1356    pub(crate) fn bytes_covering_text_payload_missing_terminator() -> Self {
1357        Self::index_corruption("text covering component payload is missing terminator")
1358    }
1359
1360    /// Construct the canonical missing persisted-field decode error.
1361    #[must_use]
1362    pub fn missing_persisted_slot(field_name: &'static str) -> Self {
1363        Self::serialize_corruption(format!("row decode: missing required field '{field_name}'"))
1364    }
1365
1366    /// Construct an identity-origin corruption error.
1367    pub(crate) fn identity_corruption(message: impl Into<String>) -> Self {
1368        Self::new(
1369            ErrorClass::Corruption,
1370            ErrorOrigin::Identity,
1371            message.into(),
1372        )
1373    }
1374
1375    /// Construct a store-origin unsupported error.
1376    #[cold]
1377    #[inline(never)]
1378    pub(crate) fn store_unsupported(message: impl Into<String>) -> Self {
1379        Self::new(ErrorClass::Unsupported, ErrorOrigin::Store, message.into())
1380    }
1381
1382    /// Construct the canonical empty migration label unsupported error.
1383    pub(crate) fn migration_label_empty(label: &str) -> Self {
1384        Self::store_unsupported(format!("{label} cannot be empty"))
1385    }
1386
1387    /// Construct the canonical empty migration-step row-op set unsupported error.
1388    pub(crate) fn migration_step_row_ops_required(name: &str) -> Self {
1389        Self::store_unsupported(format!(
1390            "migration step '{name}' must include at least one row op",
1391        ))
1392    }
1393
1394    /// Construct the canonical invalid migration-plan version unsupported error.
1395    pub(crate) fn migration_plan_version_required(id: &str) -> Self {
1396        Self::store_unsupported(format!("migration plan '{id}' version must be > 0"))
1397    }
1398
1399    /// Construct the canonical empty migration-plan steps unsupported error.
1400    pub(crate) fn migration_plan_steps_required(id: &str) -> Self {
1401        Self::store_unsupported(format!(
1402            "migration plan '{id}' must include at least one step",
1403        ))
1404    }
1405
1406    /// Construct the canonical migration cursor out-of-bounds unsupported error.
1407    pub(crate) fn migration_cursor_out_of_bounds(
1408        id: &str,
1409        version: u64,
1410        next_step: usize,
1411        total_steps: usize,
1412    ) -> Self {
1413        Self::store_unsupported(format!(
1414            "migration '{id}@{version}' cursor out of bounds: next_step={next_step} total_steps={total_steps}",
1415        ))
1416    }
1417
1418    /// Construct the canonical max-steps-required migration execution error.
1419    pub(crate) fn migration_execution_requires_max_steps(id: &str) -> Self {
1420        Self::store_unsupported(format!("migration '{id}' execution requires max_steps > 0"))
1421    }
1422
1423    /// Construct the canonical in-progress migration-plan conflict error.
1424    pub(crate) fn migration_in_progress_conflict(
1425        requested_id: &str,
1426        requested_version: u64,
1427        active_id: &str,
1428        active_version: u64,
1429    ) -> Self {
1430        Self::store_unsupported(format!(
1431            "migration '{requested_id}@{requested_version}' cannot execute while migration '{active_id}@{active_version}' is in progress",
1432        ))
1433    }
1434
1435    /// Construct the canonical unsupported persisted entity-tag store error.
1436    pub(crate) fn unsupported_entity_tag_in_data_store(
1437        entity_tag: crate::types::EntityTag,
1438    ) -> Self {
1439        Self::store_unsupported(format!(
1440            "unsupported entity tag in data store: '{}'",
1441            entity_tag.value()
1442        ))
1443    }
1444
1445    /// Construct the canonical configured-vs-registered commit-memory id mismatch error.
1446    pub(crate) fn configured_commit_memory_id_mismatch(
1447        configured_id: u8,
1448        registered_id: u8,
1449    ) -> Self {
1450        Self::store_unsupported(format!(
1451            "configured commit memory id {configured_id} does not match existing commit marker id {registered_id}",
1452        ))
1453    }
1454
1455    /// Construct the canonical occupied commit-memory id unsupported error.
1456    pub(crate) fn commit_memory_id_already_registered(memory_id: u8, label: &str) -> Self {
1457        Self::store_unsupported(format!(
1458            "configured commit memory id {memory_id} is already registered as '{label}'",
1459        ))
1460    }
1461
1462    /// Construct the canonical out-of-range commit-memory id unsupported error.
1463    pub(crate) fn commit_memory_id_outside_reserved_ranges(memory_id: u8) -> Self {
1464        Self::store_unsupported(format!(
1465            "configured commit memory id {memory_id} is outside reserved ranges",
1466        ))
1467    }
1468
1469    /// Construct the canonical commit-memory id registration failure.
1470    pub(crate) fn commit_memory_id_registration_failed(err: impl fmt::Display) -> Self {
1471        Self::store_internal(format!("commit memory id registration failed: {err}"))
1472    }
1473
1474    /// Construct an index-origin unsupported error.
1475    pub(crate) fn index_unsupported(message: impl Into<String>) -> Self {
1476        Self::new(ErrorClass::Unsupported, ErrorOrigin::Index, message.into())
1477    }
1478
1479    /// Construct the canonical index-key component size-limit unsupported error.
1480    pub(crate) fn index_component_exceeds_max_size(
1481        key_item: impl fmt::Display,
1482        len: usize,
1483        max_component_size: usize,
1484    ) -> Self {
1485        Self::index_unsupported(format!(
1486            "index component exceeds max size: key item '{key_item}' -> {len} bytes (limit {max_component_size})",
1487        ))
1488    }
1489
1490    /// Construct the canonical index-entry max-keys unsupported error during commit encoding.
1491    pub(crate) fn index_entry_exceeds_max_keys(
1492        entity_path: &str,
1493        fields: &str,
1494        keys: usize,
1495    ) -> Self {
1496        Self::index_unsupported(format!(
1497            "index entry exceeds max keys: {entity_path} ({fields}) -> {keys} keys",
1498        ))
1499    }
1500
1501    /// Construct the canonical duplicate-key invariant during commit entry encoding.
1502    #[cfg(test)]
1503    pub(crate) fn index_entry_duplicate_keys_unexpected(entity_path: &str, fields: &str) -> Self {
1504        Self::index_invariant(format!(
1505            "index entry unexpectedly contains duplicate keys: {entity_path} ({fields})",
1506        ))
1507    }
1508
1509    /// Construct the canonical index-entry key-encoding unsupported error during commit encoding.
1510    pub(crate) fn index_entry_key_encoding_failed(
1511        entity_path: &str,
1512        fields: &str,
1513        err: impl fmt::Display,
1514    ) -> Self {
1515        Self::index_unsupported(format!(
1516            "index entry key encoding failed: {entity_path} ({fields}) -> {err}",
1517        ))
1518    }
1519
1520    /// Construct a serialize-origin unsupported error.
1521    pub(crate) fn serialize_unsupported(message: impl Into<String>) -> Self {
1522        Self::new(
1523            ErrorClass::Unsupported,
1524            ErrorOrigin::Serialize,
1525            message.into(),
1526        )
1527    }
1528
1529    /// Construct a cursor-origin unsupported error.
1530    pub(crate) fn cursor_unsupported(message: impl Into<String>) -> Self {
1531        Self::new(ErrorClass::Unsupported, ErrorOrigin::Cursor, message.into())
1532    }
1533
1534    /// Construct a serialize-origin incompatible persisted-format error.
1535    pub(crate) fn serialize_incompatible_persisted_format(message: impl Into<String>) -> Self {
1536        Self::new(
1537            ErrorClass::IncompatiblePersistedFormat,
1538            ErrorOrigin::Serialize,
1539            message.into(),
1540        )
1541    }
1542
1543    /// Construct a query-origin unsupported error preserving one SQL parser
1544    /// unsupported-feature label in structured error detail.
1545    #[cfg(feature = "sql")]
1546    pub(crate) fn query_unsupported_sql_feature(feature: &'static str) -> Self {
1547        let message = format!(
1548            "SQL query is not executable in this release: unsupported SQL feature: {feature}"
1549        );
1550
1551        Self {
1552            class: ErrorClass::Unsupported,
1553            origin: ErrorOrigin::Query,
1554            message,
1555            detail: Some(ErrorDetail::Query(
1556                QueryErrorDetail::UnsupportedSqlFeature { feature },
1557            )),
1558        }
1559    }
1560
1561    pub fn store_not_found(key: impl Into<String>) -> Self {
1562        let key = key.into();
1563
1564        Self {
1565            class: ErrorClass::NotFound,
1566            origin: ErrorOrigin::Store,
1567            message: format!("data key not found: {key}"),
1568            detail: Some(ErrorDetail::Store(StoreError::NotFound { key })),
1569        }
1570    }
1571
1572    /// Construct a standardized unsupported-entity-path error.
1573    pub fn unsupported_entity_path(path: impl Into<String>) -> Self {
1574        let path = path.into();
1575
1576        Self::new(
1577            ErrorClass::Unsupported,
1578            ErrorOrigin::Store,
1579            format!("unsupported entity path: '{path}'"),
1580        )
1581    }
1582
1583    #[must_use]
1584    pub const fn is_not_found(&self) -> bool {
1585        matches!(
1586            self.detail,
1587            Some(ErrorDetail::Store(StoreError::NotFound { .. }))
1588        )
1589    }
1590
1591    #[must_use]
1592    pub fn display_with_class(&self) -> String {
1593        format!("{}:{}: {}", self.origin, self.class, self.message)
1594    }
1595
1596    /// Construct an index-plan corruption error with a canonical prefix.
1597    #[cold]
1598    #[inline(never)]
1599    pub(crate) fn index_plan_corruption(origin: ErrorOrigin, message: impl Into<String>) -> Self {
1600        let message = message.into();
1601        Self::new(
1602            ErrorClass::Corruption,
1603            origin,
1604            format!("corruption detected ({origin}): {message}"),
1605        )
1606    }
1607
1608    /// Construct an index-plan corruption error for index-origin failures.
1609    #[cold]
1610    #[inline(never)]
1611    pub(crate) fn index_plan_index_corruption(message: impl Into<String>) -> Self {
1612        Self::index_plan_corruption(ErrorOrigin::Index, message)
1613    }
1614
1615    /// Construct an index-plan corruption error for store-origin failures.
1616    #[cold]
1617    #[inline(never)]
1618    pub(crate) fn index_plan_store_corruption(message: impl Into<String>) -> Self {
1619        Self::index_plan_corruption(ErrorOrigin::Store, message)
1620    }
1621
1622    /// Construct an index-plan corruption error for serialize-origin failures.
1623    #[cold]
1624    #[inline(never)]
1625    pub(crate) fn index_plan_serialize_corruption(message: impl Into<String>) -> Self {
1626        Self::index_plan_corruption(ErrorOrigin::Serialize, message)
1627    }
1628
1629    /// Construct an index-plan invariant violation error with a canonical prefix.
1630    #[cfg(test)]
1631    pub(crate) fn index_plan_invariant(origin: ErrorOrigin, message: impl Into<String>) -> Self {
1632        let message = message.into();
1633        Self::new(
1634            ErrorClass::InvariantViolation,
1635            origin,
1636            format!("invariant violation detected ({origin}): {message}"),
1637        )
1638    }
1639
1640    /// Construct an index-plan invariant violation error for store-origin failures.
1641    #[cfg(test)]
1642    pub(crate) fn index_plan_store_invariant(message: impl Into<String>) -> Self {
1643        Self::index_plan_invariant(ErrorOrigin::Store, message)
1644    }
1645
1646    /// Construct an index uniqueness violation conflict error.
1647    pub(crate) fn index_violation(path: &str, index_fields: &[&str]) -> Self {
1648        Self::new(
1649            ErrorClass::Conflict,
1650            ErrorOrigin::Index,
1651            format!(
1652                "index constraint violation: {path} ({})",
1653                index_fields.join(", ")
1654            ),
1655        )
1656    }
1657}
1658
1659///
1660/// ErrorDetail
1661///
1662/// Structured, origin-specific error detail carried by [`InternalError`].
1663/// This enum is intentionally extensible.
1664///
1665
1666#[derive(Debug, ThisError)]
1667pub enum ErrorDetail {
1668    #[error("{0}")]
1669    Store(StoreError),
1670    #[error("{0}")]
1671    Query(QueryErrorDetail),
1672    // Future-proofing:
1673    // #[error("{0}")]
1674    // Index(IndexError),
1675    //
1676    // #[error("{0}")]
1677    // Executor(ExecutorErrorDetail),
1678}
1679
1680///
1681/// StoreError
1682///
1683/// Store-specific structured error detail.
1684/// Never returned directly; always wrapped in [`ErrorDetail::Store`].
1685///
1686
1687#[derive(Debug, ThisError)]
1688pub enum StoreError {
1689    #[error("key not found: {key}")]
1690    NotFound { key: String },
1691
1692    #[error("store corruption: {message}")]
1693    Corrupt { message: String },
1694
1695    #[error("store invariant violation: {message}")]
1696    InvariantViolation { message: String },
1697}
1698
1699///
1700/// QueryErrorDetail
1701///
1702/// Query-origin structured error detail payload.
1703///
1704
1705#[derive(Debug, ThisError)]
1706pub enum QueryErrorDetail {
1707    #[error("unsupported SQL feature: {feature}")]
1708    UnsupportedSqlFeature { feature: &'static str },
1709}
1710
1711///
1712/// ErrorClass
1713/// Internal error taxonomy for runtime classification.
1714/// Not a stable API; may change without notice.
1715///
1716
1717#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1718pub enum ErrorClass {
1719    Corruption,
1720    IncompatiblePersistedFormat,
1721    NotFound,
1722    Internal,
1723    Conflict,
1724    Unsupported,
1725    InvariantViolation,
1726}
1727
1728impl fmt::Display for ErrorClass {
1729    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1730        let label = match self {
1731            Self::Corruption => "corruption",
1732            Self::IncompatiblePersistedFormat => "incompatible_persisted_format",
1733            Self::NotFound => "not_found",
1734            Self::Internal => "internal",
1735            Self::Conflict => "conflict",
1736            Self::Unsupported => "unsupported",
1737            Self::InvariantViolation => "invariant_violation",
1738        };
1739        write!(f, "{label}")
1740    }
1741}
1742
1743///
1744/// ErrorOrigin
1745/// Internal origin taxonomy for runtime classification.
1746/// Not a stable API; may change without notice.
1747///
1748
1749#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1750pub enum ErrorOrigin {
1751    Serialize,
1752    Store,
1753    Index,
1754    Identity,
1755    Query,
1756    Planner,
1757    Cursor,
1758    Recovery,
1759    Response,
1760    Executor,
1761    Interface,
1762}
1763
1764impl fmt::Display for ErrorOrigin {
1765    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1766        let label = match self {
1767            Self::Serialize => "serialize",
1768            Self::Store => "store",
1769            Self::Index => "index",
1770            Self::Identity => "identity",
1771            Self::Query => "query",
1772            Self::Planner => "planner",
1773            Self::Cursor => "cursor",
1774            Self::Recovery => "recovery",
1775            Self::Response => "response",
1776            Self::Executor => "executor",
1777            Self::Interface => "interface",
1778        };
1779        write!(f, "{label}")
1780    }
1781}