1#[cfg(test)]
8mod tests;
9
10use crate::serialize::{SerializeError, SerializeErrorKind};
11use std::fmt;
12use thiserror::Error as ThisError;
13
14#[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 pub(crate) detail: Option<ErrorDetail>,
124}
125
126impl InternalError {
127 #[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 #[must_use]
159 pub const fn class(&self) -> ErrorClass {
160 self.class
161 }
162
163 #[must_use]
165 pub const fn origin(&self) -> ErrorOrigin {
166 self.origin
167 }
168
169 #[must_use]
171 pub fn message(&self) -> &str {
172 &self.message
173 }
174
175 #[must_use]
177 pub const fn detail(&self) -> Option<&ErrorDetail> {
178 self.detail.as_ref()
179 }
180
181 #[must_use]
183 pub fn into_message(self) -> String {
184 self.message
185 }
186
187 #[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 #[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 #[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 #[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 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 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 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 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 #[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 #[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 #[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 #[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 #[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 #[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 pub(crate) fn mutation_entity_schema_invalid(
329 entity_path: &str,
330 detail: impl fmt::Display,
331 ) -> Self {
332 Self::executor_invariant(format!("entity schema invalid for {entity_path}: {detail}"))
333 }
334
335 pub(crate) fn mutation_entity_primary_key_missing(entity_path: &str, field_name: &str) -> Self {
337 Self::executor_invariant(format!(
338 "entity primary key field missing: {entity_path} field={field_name}",
339 ))
340 }
341
342 pub(crate) fn mutation_entity_primary_key_invalid_value(
344 entity_path: &str,
345 field_name: &str,
346 value: &crate::value::Value,
347 ) -> Self {
348 Self::executor_invariant(format!(
349 "entity primary key field has invalid value: {entity_path} field={field_name} value={value:?}",
350 ))
351 }
352
353 pub(crate) fn mutation_entity_primary_key_type_mismatch(
355 entity_path: &str,
356 field_name: &str,
357 value: &crate::value::Value,
358 ) -> Self {
359 Self::executor_invariant(format!(
360 "entity primary key field type mismatch: {entity_path} field={field_name} value={value:?}",
361 ))
362 }
363
364 pub(crate) fn mutation_entity_primary_key_mismatch(
366 entity_path: &str,
367 field_name: &str,
368 field_value: &crate::value::Value,
369 identity_key: &crate::value::Value,
370 ) -> Self {
371 Self::executor_invariant(format!(
372 "entity primary key mismatch: {entity_path} field={field_name} field_value={field_value:?} id_key={identity_key:?}",
373 ))
374 }
375
376 pub(crate) fn mutation_entity_field_missing(
378 entity_path: &str,
379 field_name: &str,
380 indexed: bool,
381 ) -> Self {
382 let indexed_note = if indexed { " (indexed)" } else { "" };
383
384 Self::executor_invariant(format!(
385 "entity field missing: {entity_path} field={field_name}{indexed_note}",
386 ))
387 }
388
389 pub(crate) fn mutation_entity_field_type_mismatch(
391 entity_path: &str,
392 field_name: &str,
393 value: &crate::value::Value,
394 ) -> Self {
395 Self::executor_invariant(format!(
396 "entity field type mismatch: {entity_path} field={field_name} value={value:?}",
397 ))
398 }
399
400 #[allow(dead_code)]
405 pub(crate) fn mutation_structural_after_image_invalid(
406 entity_path: &str,
407 data_key: impl fmt::Display,
408 detail: impl AsRef<str>,
409 ) -> Self {
410 Self::executor_invariant(format!(
411 "structural mutation produced an invalid entity: {entity_path} key={data_key} ({})",
412 detail.as_ref(),
413 ))
414 }
415
416 pub(crate) fn mutation_structural_field_unknown(entity_path: &str, field_name: &str) -> Self {
418 Self::executor_invariant(format!(
419 "unknown field for structural mutation: {entity_path} field={field_name}",
420 ))
421 }
422
423 pub(crate) fn mutation_decimal_scale_mismatch(
425 entity_path: &str,
426 field_name: &str,
427 expected_scale: impl fmt::Display,
428 actual_scale: impl fmt::Display,
429 ) -> Self {
430 Self::executor_unsupported(format!(
431 "decimal field scale mismatch: {entity_path} field={field_name} expected_scale={expected_scale} actual_scale={actual_scale}",
432 ))
433 }
434
435 pub(crate) fn mutation_set_field_list_required(entity_path: &str, field_name: &str) -> Self {
437 Self::executor_invariant(format!(
438 "set field must encode as Value::List: {entity_path} field={field_name}",
439 ))
440 }
441
442 pub(crate) fn mutation_set_field_not_canonical(entity_path: &str, field_name: &str) -> Self {
444 Self::executor_invariant(format!(
445 "set field must be strictly ordered and deduplicated: {entity_path} field={field_name}",
446 ))
447 }
448
449 pub(crate) fn mutation_map_field_map_required(entity_path: &str, field_name: &str) -> Self {
451 Self::executor_invariant(format!(
452 "map field must encode as Value::Map: {entity_path} field={field_name}",
453 ))
454 }
455
456 pub(crate) fn mutation_map_field_entries_invalid(
458 entity_path: &str,
459 field_name: &str,
460 detail: impl fmt::Display,
461 ) -> Self {
462 Self::executor_invariant(format!(
463 "map field entries violate map invariants: {entity_path} field={field_name} ({detail})",
464 ))
465 }
466
467 pub(crate) fn mutation_map_field_entries_not_canonical(
469 entity_path: &str,
470 field_name: &str,
471 ) -> Self {
472 Self::executor_invariant(format!(
473 "map field entries are not in canonical deterministic order: {entity_path} field={field_name}",
474 ))
475 }
476
477 pub(crate) fn scalar_page_predicate_slots_required() -> Self {
479 Self::query_executor_invariant("post-access filtering requires precompiled predicate slots")
480 }
481
482 pub(crate) fn scalar_page_ordering_after_filtering_required() -> Self {
484 Self::query_executor_invariant("ordering must run after filtering")
485 }
486
487 pub(crate) fn scalar_page_cursor_boundary_order_required() -> Self {
489 Self::query_executor_invariant("cursor boundary requires ordering")
490 }
491
492 pub(crate) fn scalar_page_cursor_boundary_after_ordering_required() -> Self {
494 Self::query_executor_invariant("cursor boundary must run after ordering")
495 }
496
497 pub(crate) fn scalar_page_pagination_after_ordering_required() -> Self {
499 Self::query_executor_invariant("pagination must run after ordering")
500 }
501
502 pub(crate) fn scalar_page_delete_limit_after_ordering_required() -> Self {
504 Self::query_executor_invariant("delete limit must run after ordering")
505 }
506
507 pub(crate) fn load_runtime_scalar_payload_required() -> Self {
509 Self::query_executor_invariant("scalar load mode must carry scalar runtime payload")
510 }
511
512 pub(crate) fn load_runtime_grouped_payload_required() -> Self {
514 Self::query_executor_invariant("grouped load mode must carry grouped runtime payload")
515 }
516
517 pub(crate) fn load_runtime_scalar_surface_payload_required() -> Self {
519 Self::query_executor_invariant("scalar page load mode must carry scalar runtime payload")
520 }
521
522 pub(crate) fn load_runtime_grouped_surface_payload_required() -> Self {
524 Self::query_executor_invariant("grouped page load mode must carry grouped runtime payload")
525 }
526
527 pub(crate) fn load_executor_load_plan_required() -> Self {
529 Self::query_executor_invariant("load executor requires load plans")
530 }
531
532 pub(crate) fn delete_executor_grouped_unsupported() -> Self {
534 Self::executor_unsupported("grouped query execution is not yet enabled in this release")
535 }
536
537 pub(crate) fn delete_executor_delete_plan_required() -> Self {
539 Self::query_executor_invariant("delete executor requires delete plans")
540 }
541
542 pub(crate) fn aggregate_fold_mode_terminal_contract_required() -> Self {
544 Self::query_executor_invariant(
545 "aggregate fold mode must match route fold-mode contract for aggregate terminal",
546 )
547 }
548
549 pub(crate) fn fast_stream_exact_key_count_required() -> Self {
551 Self::query_executor_invariant("fast-path stream must expose an exact key-count hint")
552 }
553
554 pub(crate) fn fast_stream_route_kind_request_match_required() -> Self {
556 Self::query_executor_invariant("fast-stream route kind/request mismatch")
557 }
558
559 pub(crate) fn secondary_index_prefix_spec_required() -> Self {
561 Self::query_executor_invariant(
562 "index-prefix executable spec must be materialized for index-prefix plans",
563 )
564 }
565
566 pub(crate) fn index_range_limit_spec_required() -> Self {
568 Self::query_executor_invariant(
569 "index-range executable spec must be materialized for index-range plans",
570 )
571 }
572
573 pub(crate) fn row_layout_primary_key_slot_required() -> Self {
575 Self::query_executor_invariant("row layout missing primary-key slot")
576 }
577
578 pub(crate) fn mutation_atomic_save_duplicate_key(
580 entity_path: &str,
581 key: impl fmt::Display,
582 ) -> Self {
583 Self::executor_unsupported(format!(
584 "atomic save batch rejected duplicate key: entity={entity_path} key={key}",
585 ))
586 }
587
588 pub(crate) fn mutation_index_store_generation_changed(
590 expected_generation: u64,
591 observed_generation: u64,
592 ) -> Self {
593 Self::executor_invariant(format!(
594 "index store generation changed between preflight and apply: expected {expected_generation}, found {observed_generation}",
595 ))
596 }
597
598 #[must_use]
600 #[cold]
601 #[inline(never)]
602 pub(crate) fn executor_invariant_message(reason: impl Into<String>) -> String {
603 format!("executor invariant violated: {}", reason.into())
604 }
605
606 #[cold]
608 #[inline(never)]
609 pub(crate) fn planner_invariant(message: impl Into<String>) -> Self {
610 Self::new(
611 ErrorClass::InvariantViolation,
612 ErrorOrigin::Planner,
613 message.into(),
614 )
615 }
616
617 #[must_use]
619 pub(crate) fn invalid_logical_plan_message(reason: impl Into<String>) -> String {
620 format!("invalid logical plan: {}", reason.into())
621 }
622
623 pub(crate) fn query_invalid_logical_plan(reason: impl Into<String>) -> Self {
625 Self::planner_invariant(Self::invalid_logical_plan_message(reason))
626 }
627
628 #[cold]
630 #[inline(never)]
631 pub(crate) fn query_invariant(message: impl Into<String>) -> Self {
632 Self::new(
633 ErrorClass::InvariantViolation,
634 ErrorOrigin::Query,
635 message.into(),
636 )
637 }
638
639 pub(crate) fn store_invariant(message: impl Into<String>) -> Self {
641 Self::new(
642 ErrorClass::InvariantViolation,
643 ErrorOrigin::Store,
644 message.into(),
645 )
646 }
647
648 pub(crate) fn duplicate_runtime_hooks_for_entity_tag(
650 entity_tag: crate::types::EntityTag,
651 ) -> Self {
652 Self::store_invariant(format!(
653 "duplicate runtime hooks for entity tag '{}'",
654 entity_tag.value()
655 ))
656 }
657
658 pub(crate) fn duplicate_runtime_hooks_for_entity_path(entity_path: &str) -> Self {
660 Self::store_invariant(format!(
661 "duplicate runtime hooks for entity path '{entity_path}'"
662 ))
663 }
664
665 #[cold]
667 #[inline(never)]
668 pub(crate) fn store_internal(message: impl Into<String>) -> Self {
669 Self::new(ErrorClass::Internal, ErrorOrigin::Store, message.into())
670 }
671
672 pub(crate) fn commit_memory_id_unconfigured() -> Self {
674 Self::store_internal(
675 "commit memory id is not configured; initialize recovery before commit store access",
676 )
677 }
678
679 pub(crate) fn commit_memory_id_mismatch(cached_id: u8, configured_id: u8) -> Self {
681 Self::store_internal(format!(
682 "commit memory id mismatch: cached={cached_id}, configured={configured_id}",
683 ))
684 }
685
686 pub(crate) fn commit_memory_registry_init_failed(err: impl fmt::Display) -> Self {
688 Self::store_internal(format!("memory registry init failed: {err}"))
689 }
690
691 pub(crate) fn migration_next_step_index_u64_required(id: &str, version: u64) -> Self {
693 Self::store_internal(format!(
694 "migration '{id}@{version}' next step index does not fit persisted u64 cursor",
695 ))
696 }
697
698 pub(crate) fn recovery_integrity_validation_failed(
700 missing_index_entries: u64,
701 divergent_index_entries: u64,
702 orphan_index_references: u64,
703 ) -> Self {
704 Self::store_corruption(format!(
705 "recovery integrity validation failed: missing_index_entries={missing_index_entries} divergent_index_entries={divergent_index_entries} orphan_index_references={orphan_index_references}",
706 ))
707 }
708
709 #[cold]
711 #[inline(never)]
712 pub(crate) fn index_internal(message: impl Into<String>) -> Self {
713 Self::new(ErrorClass::Internal, ErrorOrigin::Index, message.into())
714 }
715
716 pub(crate) fn structural_index_removal_entity_key_required() -> Self {
718 Self::index_internal("missing old entity key for structural index removal")
719 }
720
721 pub(crate) fn structural_index_insertion_entity_key_required() -> Self {
723 Self::index_internal("missing new entity key for structural index insertion")
724 }
725
726 pub(crate) fn index_commit_op_old_entity_key_required() -> Self {
728 Self::index_internal("missing old entity key for index removal")
729 }
730
731 pub(crate) fn index_commit_op_new_entity_key_required() -> Self {
733 Self::index_internal("missing new entity key for index insertion")
734 }
735
736 #[cfg(test)]
738 pub(crate) fn query_internal(message: impl Into<String>) -> Self {
739 Self::new(ErrorClass::Internal, ErrorOrigin::Query, message.into())
740 }
741
742 #[cold]
744 #[inline(never)]
745 pub(crate) fn query_unsupported(message: impl Into<String>) -> Self {
746 Self::new(ErrorClass::Unsupported, ErrorOrigin::Query, message.into())
747 }
748
749 #[cold]
751 #[inline(never)]
752 pub(crate) fn serialize_internal(message: impl Into<String>) -> Self {
753 Self::new(ErrorClass::Internal, ErrorOrigin::Serialize, message.into())
754 }
755
756 pub(crate) fn persisted_row_encode_failed(detail: impl fmt::Display) -> Self {
758 Self::serialize_internal(format!("row encode failed: {detail}"))
759 }
760
761 pub(crate) fn persisted_row_field_encode_failed(
763 field_name: &str,
764 detail: impl fmt::Display,
765 ) -> Self {
766 Self::serialize_internal(format!(
767 "row encode failed for field '{field_name}': {detail}",
768 ))
769 }
770
771 pub(crate) fn bytes_field_value_encode_failed(detail: impl fmt::Display) -> Self {
773 Self::serialize_internal(format!("bytes(field) value encode failed: {detail}"))
774 }
775
776 pub(crate) fn migration_state_serialize_failed(err: impl fmt::Display) -> Self {
778 Self::serialize_internal(format!("failed to serialize migration state: {err}"))
779 }
780
781 #[cold]
783 #[inline(never)]
784 pub(crate) fn store_corruption(message: impl Into<String>) -> Self {
785 Self::new(ErrorClass::Corruption, ErrorOrigin::Store, message.into())
786 }
787
788 pub(crate) fn multiple_commit_memory_ids_registered(ids: impl fmt::Debug) -> Self {
790 Self::store_corruption(format!(
791 "multiple commit marker memory ids registered: {ids:?}"
792 ))
793 }
794
795 pub(crate) fn migration_persisted_step_index_invalid_usize(
797 id: &str,
798 version: u64,
799 step_index: u64,
800 ) -> Self {
801 Self::store_corruption(format!(
802 "migration '{id}@{version}' persisted step index does not fit runtime usize: {step_index}",
803 ))
804 }
805
806 pub(crate) fn migration_persisted_step_index_out_of_bounds(
808 id: &str,
809 version: u64,
810 step_index: usize,
811 total_steps: usize,
812 ) -> Self {
813 Self::store_corruption(format!(
814 "migration '{id}@{version}' persisted step index out of bounds: {step_index} > {total_steps}",
815 ))
816 }
817
818 pub(crate) fn commit_corruption(detail: impl fmt::Display) -> Self {
820 Self::store_corruption(format!("commit marker corrupted: {detail}"))
821 }
822
823 pub(crate) fn commit_component_corruption(component: &str, detail: impl fmt::Display) -> Self {
825 Self::store_corruption(format!("commit marker {component} corrupted: {detail}"))
826 }
827
828 pub(crate) fn commit_id_generation_failed(detail: impl fmt::Display) -> Self {
830 Self::store_internal(format!("commit id generation failed: {detail}"))
831 }
832
833 pub(crate) fn commit_marker_payload_exceeds_u32_length_limit(label: &str, len: usize) -> Self {
835 Self::store_unsupported(format!("{label} exceeds u32 length limit: {len} bytes"))
836 }
837
838 pub(crate) fn commit_component_length_invalid(
840 component: &str,
841 len: usize,
842 expected: impl fmt::Display,
843 ) -> Self {
844 Self::commit_component_corruption(
845 component,
846 format!("invalid length {len}, expected {expected}"),
847 )
848 }
849
850 pub(crate) fn commit_marker_exceeds_max_size(size: usize, max_size: u32) -> Self {
852 Self::commit_corruption(format!(
853 "commit marker exceeds max size: {size} bytes (limit {max_size})",
854 ))
855 }
856
857 pub(crate) fn commit_marker_exceeds_max_size_before_persist(
859 size: usize,
860 max_size: u32,
861 ) -> Self {
862 Self::store_unsupported(format!(
863 "commit marker exceeds max size: {size} bytes (limit {max_size})",
864 ))
865 }
866
867 pub(crate) fn commit_control_slot_exceeds_max_size(size: usize, max_size: u32) -> Self {
869 Self::store_unsupported(format!(
870 "commit control slot exceeds max size: {size} bytes (limit {max_size})",
871 ))
872 }
873
874 pub(crate) fn commit_control_slot_marker_bytes_exceed_u32_length_limit(size: usize) -> Self {
876 Self::store_unsupported(format!(
877 "commit marker bytes exceed u32 length limit: {size} bytes",
878 ))
879 }
880
881 pub(crate) fn commit_control_slot_migration_bytes_exceed_u32_length_limit(size: usize) -> Self {
883 Self::store_unsupported(format!(
884 "commit migration bytes exceed u32 length limit: {size} bytes",
885 ))
886 }
887
888 pub(crate) fn startup_index_rebuild_invalid_data_key(
890 store_path: &str,
891 detail: impl fmt::Display,
892 ) -> Self {
893 Self::store_corruption(format!(
894 "startup index rebuild failed: invalid data key in store '{store_path}' ({detail})",
895 ))
896 }
897
898 #[cold]
900 #[inline(never)]
901 pub(crate) fn index_corruption(message: impl Into<String>) -> Self {
902 Self::new(ErrorClass::Corruption, ErrorOrigin::Index, message.into())
903 }
904
905 pub(crate) fn index_unique_validation_corruption(
907 entity_path: &str,
908 fields: &str,
909 detail: impl fmt::Display,
910 ) -> Self {
911 Self::index_plan_index_corruption(format!(
912 "index corrupted: {entity_path} ({fields}) -> {detail}",
913 ))
914 }
915
916 pub(crate) fn structural_index_entry_corruption(
918 entity_path: &str,
919 fields: &str,
920 detail: impl fmt::Display,
921 ) -> Self {
922 Self::index_plan_index_corruption(format!(
923 "index corrupted: {entity_path} ({fields}) -> {detail}",
924 ))
925 }
926
927 pub(crate) fn index_unique_validation_entity_key_required() -> Self {
929 Self::index_invariant("missing entity key during unique validation")
930 }
931
932 pub(crate) fn index_unique_validation_key_component_missing(
934 component_index: usize,
935 entity_path: &str,
936 fields: &str,
937 ) -> Self {
938 Self::index_invariant(format!(
939 "index key missing component {component_index} during unique validation: {entity_path} ({fields})",
940 ))
941 }
942
943 pub(crate) fn index_unique_validation_expected_component_missing(
945 component_index: usize,
946 entity_path: &str,
947 fields: &str,
948 ) -> Self {
949 Self::index_invariant(format!(
950 "index key missing expected component {component_index} during unique validation: {entity_path} ({fields})",
951 ))
952 }
953
954 pub(crate) fn index_unique_validation_primary_key_field_missing(
956 entity_path: &str,
957 primary_key_name: &str,
958 ) -> Self {
959 Self::index_invariant(format!(
960 "entity primary key field missing during unique validation: {entity_path} field={primary_key_name}",
961 ))
962 }
963
964 pub(crate) fn index_unique_validation_row_deserialize_failed(
966 data_key: impl fmt::Display,
967 source: impl fmt::Display,
968 ) -> Self {
969 Self::index_plan_serialize_corruption(format!(
970 "failed to structurally deserialize row: {data_key} ({source})"
971 ))
972 }
973
974 pub(crate) fn index_unique_validation_primary_key_decode_failed(
976 data_key: impl fmt::Display,
977 source: impl fmt::Display,
978 ) -> Self {
979 Self::index_plan_serialize_corruption(format!(
980 "failed to decode structural primary-key slot: {data_key} ({source})"
981 ))
982 }
983
984 pub(crate) fn index_unique_validation_key_rebuild_failed(
986 data_key: impl fmt::Display,
987 entity_path: &str,
988 source: impl fmt::Display,
989 ) -> Self {
990 Self::index_plan_serialize_corruption(format!(
991 "failed to structurally decode unique key row {data_key} for {entity_path}: {source}",
992 ))
993 }
994
995 pub(crate) fn index_unique_validation_row_required(data_key: impl fmt::Display) -> Self {
997 Self::index_plan_store_corruption(format!("missing row: {data_key}"))
998 }
999
1000 pub(crate) fn index_unique_validation_row_key_mismatch(
1002 entity_path: &str,
1003 fields: &str,
1004 detail: impl fmt::Display,
1005 ) -> Self {
1006 Self::index_plan_store_invariant(format!(
1007 "index invariant violated: {entity_path} ({fields}) -> {detail}",
1008 ))
1009 }
1010
1011 pub(crate) fn index_predicate_parse_failed(
1013 entity_path: &str,
1014 index_name: &str,
1015 predicate_sql: &str,
1016 err: impl fmt::Display,
1017 ) -> Self {
1018 Self::index_invariant(format!(
1019 "index predicate parse failed: {entity_path} ({index_name}) WHERE {predicate_sql} -> {err}",
1020 ))
1021 }
1022
1023 pub(crate) fn index_only_predicate_component_required() -> Self {
1025 Self::index_invariant("index-only predicate program referenced missing index component")
1026 }
1027
1028 pub(crate) fn index_scan_continuation_anchor_within_envelope_required() -> Self {
1030 Self::index_invariant(
1031 "index-range continuation anchor is outside the requested range envelope",
1032 )
1033 }
1034
1035 pub(crate) fn index_scan_continuation_advancement_required() -> Self {
1037 Self::index_invariant("index-range continuation scan did not advance beyond the anchor")
1038 }
1039
1040 pub(crate) fn index_scan_key_corrupted_during(
1042 context: &'static str,
1043 err: impl fmt::Display,
1044 ) -> Self {
1045 Self::index_corruption(format!("index key corrupted during {context}: {err}"))
1046 }
1047
1048 pub(crate) fn index_projection_component_required(
1050 index_name: &str,
1051 component_index: usize,
1052 ) -> Self {
1053 Self::index_invariant(format!(
1054 "index projection referenced missing component: index='{index_name}' component_index={component_index}",
1055 ))
1056 }
1057
1058 pub(crate) fn unique_index_entry_single_key_required() -> Self {
1060 Self::index_corruption("unique index entry contains an unexpected number of keys")
1061 }
1062
1063 pub(crate) fn index_entry_decode_failed(err: impl fmt::Display) -> Self {
1065 Self::index_corruption(err.to_string())
1066 }
1067
1068 pub(crate) fn serialize_corruption(message: impl Into<String>) -> Self {
1070 Self::new(
1071 ErrorClass::Corruption,
1072 ErrorOrigin::Serialize,
1073 message.into(),
1074 )
1075 }
1076
1077 pub(crate) fn persisted_row_decode_failed(detail: impl fmt::Display) -> Self {
1079 Self::serialize_corruption(format!("row decode failed: {detail}"))
1080 }
1081
1082 pub(crate) fn persisted_row_field_decode_failed(
1084 field_name: &str,
1085 detail: impl fmt::Display,
1086 ) -> Self {
1087 Self::serialize_corruption(format!(
1088 "row decode failed for field '{field_name}': {detail}",
1089 ))
1090 }
1091
1092 pub(crate) fn persisted_row_field_kind_decode_failed(
1094 field_name: &str,
1095 field_kind: impl fmt::Debug,
1096 detail: impl fmt::Display,
1097 ) -> Self {
1098 Self::persisted_row_field_decode_failed(
1099 field_name,
1100 format!("kind={field_kind:?}: {detail}"),
1101 )
1102 }
1103
1104 pub(crate) fn persisted_row_field_payload_exact_len_required(
1106 field_name: &str,
1107 payload_kind: &str,
1108 expected_len: usize,
1109 ) -> Self {
1110 let unit = if expected_len == 1 { "byte" } else { "bytes" };
1111
1112 Self::persisted_row_field_decode_failed(
1113 field_name,
1114 format!("{payload_kind} payload must be exactly {expected_len} {unit}"),
1115 )
1116 }
1117
1118 pub(crate) fn persisted_row_field_payload_must_be_empty(
1120 field_name: &str,
1121 payload_kind: &str,
1122 ) -> Self {
1123 Self::persisted_row_field_decode_failed(
1124 field_name,
1125 format!("{payload_kind} payload must be empty"),
1126 )
1127 }
1128
1129 pub(crate) fn persisted_row_field_payload_invalid_byte(
1131 field_name: &str,
1132 payload_kind: &str,
1133 value: u8,
1134 ) -> Self {
1135 Self::persisted_row_field_decode_failed(
1136 field_name,
1137 format!("invalid {payload_kind} payload byte {value}"),
1138 )
1139 }
1140
1141 pub(crate) fn persisted_row_field_payload_non_finite(
1143 field_name: &str,
1144 payload_kind: &str,
1145 ) -> Self {
1146 Self::persisted_row_field_decode_failed(
1147 field_name,
1148 format!("{payload_kind} payload is non-finite"),
1149 )
1150 }
1151
1152 pub(crate) fn persisted_row_field_payload_out_of_range(
1154 field_name: &str,
1155 payload_kind: &str,
1156 ) -> Self {
1157 Self::persisted_row_field_decode_failed(
1158 field_name,
1159 format!("{payload_kind} payload out of range for target type"),
1160 )
1161 }
1162
1163 pub(crate) fn persisted_row_field_text_payload_invalid_utf8(
1165 field_name: &str,
1166 detail: impl fmt::Display,
1167 ) -> Self {
1168 Self::persisted_row_field_decode_failed(
1169 field_name,
1170 format!("invalid UTF-8 text payload ({detail})"),
1171 )
1172 }
1173
1174 pub(crate) fn persisted_row_slot_lookup_out_of_bounds(model_path: &str, slot: usize) -> Self {
1176 Self::index_invariant(format!(
1177 "slot lookup outside model bounds during structural row access: model='{model_path}' slot={slot}",
1178 ))
1179 }
1180
1181 pub(crate) fn persisted_row_slot_cache_lookup_out_of_bounds(
1183 model_path: &str,
1184 slot: usize,
1185 ) -> Self {
1186 Self::index_invariant(format!(
1187 "slot cache lookup outside model bounds during structural row access: model='{model_path}' slot={slot}",
1188 ))
1189 }
1190
1191 pub(crate) fn persisted_row_primary_key_field_missing(model_path: &str) -> Self {
1193 Self::index_invariant(format!(
1194 "entity primary key field missing during structural row validation: {model_path}",
1195 ))
1196 }
1197
1198 pub(crate) fn persisted_row_primary_key_not_storage_encodable(
1200 data_key: impl fmt::Display,
1201 detail: impl fmt::Display,
1202 ) -> Self {
1203 Self::persisted_row_decode_failed(format!(
1204 "primary-key value is not storage-key encodable: {data_key} ({detail})",
1205 ))
1206 }
1207
1208 pub(crate) fn persisted_row_primary_key_slot_missing(data_key: impl fmt::Display) -> Self {
1210 Self::persisted_row_decode_failed(format!(
1211 "missing primary-key slot while validating {data_key}",
1212 ))
1213 }
1214
1215 pub(crate) fn persisted_row_key_mismatch(
1217 expected_key: impl fmt::Display,
1218 found_key: impl fmt::Display,
1219 ) -> Self {
1220 Self::store_corruption(format!(
1221 "row key mismatch: expected {expected_key}, found {found_key}",
1222 ))
1223 }
1224
1225 pub(crate) fn row_decode_declared_field_missing(field_name: &str) -> Self {
1227 Self::persisted_row_decode_failed(format!("missing declared field `{field_name}`"))
1228 }
1229
1230 pub(crate) fn row_decode_field_decode_failed(
1232 field_name: &str,
1233 field_kind: impl fmt::Debug,
1234 detail: impl fmt::Display,
1235 ) -> Self {
1236 Self::serialize_corruption(format!(
1237 "row decode failed for field '{field_name}' kind={field_kind:?}: {detail}",
1238 ))
1239 }
1240
1241 pub(crate) fn row_decode_primary_key_slot_missing() -> Self {
1243 Self::persisted_row_decode_failed("missing primary-key slot value")
1244 }
1245
1246 pub(crate) fn row_decode_primary_key_not_storage_encodable(detail: impl fmt::Display) -> Self {
1248 Self::persisted_row_decode_failed(format!(
1249 "primary-key value is not storage-key encodable: {detail}",
1250 ))
1251 }
1252
1253 pub(crate) fn row_decode_key_mismatch(
1255 expected_key: impl fmt::Display,
1256 found_key: impl fmt::Display,
1257 ) -> Self {
1258 Self::persisted_row_key_mismatch(expected_key, found_key)
1259 }
1260
1261 pub(crate) fn data_key_entity_mismatch(
1263 expected: impl fmt::Display,
1264 found: impl fmt::Display,
1265 ) -> Self {
1266 Self::store_corruption(format!(
1267 "data key entity mismatch: expected {expected}, found {found}",
1268 ))
1269 }
1270
1271 pub(crate) fn data_key_primary_key_decode_failed(value: impl fmt::Debug) -> Self {
1273 Self::store_corruption(format!("data key primary key decode failed: {value:?}",))
1274 }
1275
1276 pub(crate) fn reverse_index_ordinal_overflow(
1278 source_path: &str,
1279 field_name: &str,
1280 target_path: &str,
1281 detail: impl fmt::Display,
1282 ) -> Self {
1283 Self::index_internal(format!(
1284 "reverse index ordinal overflow: source={source_path} field={field_name} target={target_path} ({detail})",
1285 ))
1286 }
1287
1288 pub(crate) fn reverse_index_entry_corrupted(
1290 source_path: &str,
1291 field_name: &str,
1292 target_path: &str,
1293 index_key: impl fmt::Debug,
1294 detail: impl fmt::Display,
1295 ) -> Self {
1296 Self::index_corruption(format!(
1297 "reverse index entry corrupted: source={source_path} field={field_name} target={target_path} key={index_key:?} ({detail})",
1298 ))
1299 }
1300
1301 pub(crate) fn reverse_index_entry_encode_failed(
1303 source_path: &str,
1304 field_name: &str,
1305 target_path: &str,
1306 detail: impl fmt::Display,
1307 ) -> Self {
1308 Self::index_unsupported(format!(
1309 "reverse index entry encoding failed: source={source_path} field={field_name} target={target_path} ({detail})",
1310 ))
1311 }
1312
1313 pub(crate) fn relation_target_store_missing(
1315 source_path: &str,
1316 field_name: &str,
1317 target_path: &str,
1318 store_path: &str,
1319 detail: impl fmt::Display,
1320 ) -> Self {
1321 Self::executor_internal(format!(
1322 "relation target store missing: source={source_path} field={field_name} target={target_path} store={store_path} ({detail})",
1323 ))
1324 }
1325
1326 pub(crate) fn relation_target_key_decode_failed(
1328 context_label: &str,
1329 source_path: &str,
1330 field_name: &str,
1331 target_path: &str,
1332 detail: impl fmt::Display,
1333 ) -> Self {
1334 Self::identity_corruption(format!(
1335 "{context_label}: source={source_path} field={field_name} target={target_path} ({detail})",
1336 ))
1337 }
1338
1339 pub(crate) fn relation_target_entity_mismatch(
1341 context_label: &str,
1342 source_path: &str,
1343 field_name: &str,
1344 target_path: &str,
1345 target_entity_name: &str,
1346 expected_tag: impl fmt::Display,
1347 actual_tag: impl fmt::Display,
1348 ) -> Self {
1349 Self::store_corruption(format!(
1350 "{context_label}: source={source_path} field={field_name} target={target_path} expected={target_entity_name} (tag={expected_tag}) actual_tag={actual_tag}",
1351 ))
1352 }
1353
1354 pub(crate) fn relation_source_row_missing_field(
1356 source_path: &str,
1357 field_name: &str,
1358 target_path: &str,
1359 ) -> Self {
1360 Self::serialize_corruption(format!(
1361 "relation source row decode failed: missing field: source={source_path} field={field_name} target={target_path}",
1362 ))
1363 }
1364
1365 pub(crate) fn relation_source_row_decode_failed(
1367 source_path: &str,
1368 field_name: &str,
1369 target_path: &str,
1370 detail: impl fmt::Display,
1371 ) -> Self {
1372 Self::serialize_corruption(format!(
1373 "relation source row decode failed: source={source_path} field={field_name} target={target_path} ({detail})",
1374 ))
1375 }
1376
1377 pub(crate) fn relation_source_row_unsupported_scalar_relation_key(
1379 source_path: &str,
1380 field_name: &str,
1381 target_path: &str,
1382 ) -> Self {
1383 Self::serialize_corruption(format!(
1384 "relation source row decode failed: unsupported scalar relation key: source={source_path} field={field_name} target={target_path}",
1385 ))
1386 }
1387
1388 pub(crate) fn relation_source_row_invalid_field_kind(field_kind: impl fmt::Debug) -> Self {
1390 Self::serialize_corruption(format!(
1391 "invalid strong relation field kind during structural decode: {field_kind:?}"
1392 ))
1393 }
1394
1395 pub(crate) fn relation_source_row_unsupported_key_kind(field_kind: impl fmt::Debug) -> Self {
1397 Self::serialize_corruption(format!(
1398 "unsupported strong relation key kind during structural decode: {field_kind:?}"
1399 ))
1400 }
1401
1402 pub(crate) fn reverse_index_relation_target_decode_invariant_violated(
1404 source_path: &str,
1405 field_name: &str,
1406 target_path: &str,
1407 ) -> Self {
1408 Self::executor_internal(format!(
1409 "relation target decode invariant violated while preparing reverse index: source={source_path} field={field_name} target={target_path}",
1410 ))
1411 }
1412
1413 pub(crate) fn bytes_covering_component_payload_empty() -> Self {
1415 Self::index_corruption("index component payload is empty during covering projection decode")
1416 }
1417
1418 pub(crate) fn bytes_covering_bool_payload_truncated() -> Self {
1420 Self::index_corruption("bool covering component payload is truncated")
1421 }
1422
1423 pub(crate) fn bytes_covering_component_payload_invalid_length(payload_kind: &str) -> Self {
1425 Self::index_corruption(format!(
1426 "{payload_kind} covering component payload has invalid length"
1427 ))
1428 }
1429
1430 pub(crate) fn bytes_covering_bool_payload_invalid_value() -> Self {
1432 Self::index_corruption("bool covering component payload has invalid value")
1433 }
1434
1435 pub(crate) fn bytes_covering_text_payload_invalid_terminator() -> Self {
1437 Self::index_corruption("text covering component payload has invalid terminator")
1438 }
1439
1440 pub(crate) fn bytes_covering_text_payload_trailing_bytes() -> Self {
1442 Self::index_corruption("text covering component payload contains trailing bytes")
1443 }
1444
1445 pub(crate) fn bytes_covering_text_payload_invalid_utf8() -> Self {
1447 Self::index_corruption("text covering component payload is not valid UTF-8")
1448 }
1449
1450 pub(crate) fn bytes_covering_text_payload_invalid_escape_byte() -> Self {
1452 Self::index_corruption("text covering component payload has invalid escape byte")
1453 }
1454
1455 pub(crate) fn bytes_covering_text_payload_missing_terminator() -> Self {
1457 Self::index_corruption("text covering component payload is missing terminator")
1458 }
1459
1460 #[must_use]
1462 pub fn missing_persisted_slot(field_name: &'static str) -> Self {
1463 Self::serialize_corruption(format!(
1464 "row decode failed: missing required field '{field_name}'",
1465 ))
1466 }
1467
1468 pub(crate) fn identity_corruption(message: impl Into<String>) -> Self {
1470 Self::new(
1471 ErrorClass::Corruption,
1472 ErrorOrigin::Identity,
1473 message.into(),
1474 )
1475 }
1476
1477 #[cold]
1479 #[inline(never)]
1480 pub(crate) fn store_unsupported(message: impl Into<String>) -> Self {
1481 Self::new(ErrorClass::Unsupported, ErrorOrigin::Store, message.into())
1482 }
1483
1484 pub(crate) fn migration_label_empty(label: &str) -> Self {
1486 Self::store_unsupported(format!("{label} cannot be empty"))
1487 }
1488
1489 pub(crate) fn migration_step_row_ops_required(name: &str) -> Self {
1491 Self::store_unsupported(format!(
1492 "migration step '{name}' must include at least one row op",
1493 ))
1494 }
1495
1496 pub(crate) fn migration_plan_version_required(id: &str) -> Self {
1498 Self::store_unsupported(format!("migration plan '{id}' version must be > 0",))
1499 }
1500
1501 pub(crate) fn migration_plan_steps_required(id: &str) -> Self {
1503 Self::store_unsupported(format!(
1504 "migration plan '{id}' must include at least one step",
1505 ))
1506 }
1507
1508 pub(crate) fn migration_cursor_out_of_bounds(
1510 id: &str,
1511 version: u64,
1512 next_step: usize,
1513 total_steps: usize,
1514 ) -> Self {
1515 Self::store_unsupported(format!(
1516 "migration '{id}@{version}' cursor out of bounds: next_step={next_step} total_steps={total_steps}",
1517 ))
1518 }
1519
1520 pub(crate) fn migration_execution_requires_max_steps(id: &str) -> Self {
1522 Self::store_unsupported(format!("migration '{id}' execution requires max_steps > 0",))
1523 }
1524
1525 pub(crate) fn migration_in_progress_conflict(
1527 requested_id: &str,
1528 requested_version: u64,
1529 active_id: &str,
1530 active_version: u64,
1531 ) -> Self {
1532 Self::store_unsupported(format!(
1533 "migration '{requested_id}@{requested_version}' cannot execute while migration '{active_id}@{active_version}' is in progress",
1534 ))
1535 }
1536
1537 pub(crate) fn unsupported_entity_tag_in_data_store(
1539 entity_tag: crate::types::EntityTag,
1540 ) -> Self {
1541 Self::store_unsupported(format!(
1542 "unsupported entity tag in data store: '{}'",
1543 entity_tag.value()
1544 ))
1545 }
1546
1547 pub(crate) fn configured_commit_memory_id_mismatch(
1549 configured_id: u8,
1550 registered_id: u8,
1551 ) -> Self {
1552 Self::store_unsupported(format!(
1553 "configured commit memory id {configured_id} does not match existing commit marker id {registered_id}",
1554 ))
1555 }
1556
1557 pub(crate) fn commit_memory_id_already_registered(memory_id: u8, label: &str) -> Self {
1559 Self::store_unsupported(format!(
1560 "configured commit memory id {memory_id} is already registered as '{label}'",
1561 ))
1562 }
1563
1564 pub(crate) fn commit_memory_id_outside_reserved_ranges(memory_id: u8) -> Self {
1566 Self::store_unsupported(format!(
1567 "configured commit memory id {memory_id} is outside reserved ranges",
1568 ))
1569 }
1570
1571 pub(crate) fn commit_memory_id_registration_failed(err: impl fmt::Display) -> Self {
1573 Self::store_internal(format!("commit memory id registration failed: {err}"))
1574 }
1575
1576 pub(crate) fn index_unsupported(message: impl Into<String>) -> Self {
1578 Self::new(ErrorClass::Unsupported, ErrorOrigin::Index, message.into())
1579 }
1580
1581 pub(crate) fn index_component_exceeds_max_size(
1583 key_item: impl fmt::Display,
1584 len: usize,
1585 max_component_size: usize,
1586 ) -> Self {
1587 Self::index_unsupported(format!(
1588 "index component exceeds max size: key item '{key_item}' -> {len} bytes (limit {max_component_size})",
1589 ))
1590 }
1591
1592 pub(crate) fn index_entry_exceeds_max_keys(
1594 entity_path: &str,
1595 fields: &str,
1596 keys: usize,
1597 ) -> Self {
1598 Self::index_unsupported(format!(
1599 "index entry exceeds max keys: {entity_path} ({fields}) -> {keys} keys",
1600 ))
1601 }
1602
1603 pub(crate) fn index_entry_duplicate_keys_unexpected(entity_path: &str, fields: &str) -> Self {
1605 Self::index_invariant(format!(
1606 "index entry unexpectedly contains duplicate keys: {entity_path} ({fields})",
1607 ))
1608 }
1609
1610 pub(crate) fn index_entry_key_encoding_failed(
1612 entity_path: &str,
1613 fields: &str,
1614 err: impl fmt::Display,
1615 ) -> Self {
1616 Self::index_unsupported(format!(
1617 "index entry key encoding failed: {entity_path} ({fields}) -> {err}",
1618 ))
1619 }
1620
1621 pub(crate) fn serialize_unsupported(message: impl Into<String>) -> Self {
1623 Self::new(
1624 ErrorClass::Unsupported,
1625 ErrorOrigin::Serialize,
1626 message.into(),
1627 )
1628 }
1629
1630 pub(crate) fn cursor_unsupported(message: impl Into<String>) -> Self {
1632 Self::new(ErrorClass::Unsupported, ErrorOrigin::Cursor, message.into())
1633 }
1634
1635 pub(crate) fn serialize_incompatible_persisted_format(message: impl Into<String>) -> Self {
1637 Self::new(
1638 ErrorClass::IncompatiblePersistedFormat,
1639 ErrorOrigin::Serialize,
1640 message.into(),
1641 )
1642 }
1643
1644 pub(crate) fn serialize_payload_decode_failed(
1647 source: SerializeError,
1648 payload_label: &'static str,
1649 ) -> Self {
1650 match source {
1651 SerializeError::DeserializeSizeLimitExceeded { len, max_bytes } => {
1654 Self::serialize_corruption(format!(
1655 "{payload_label} decode failed: payload size {len} exceeds limit {max_bytes}"
1656 ))
1657 }
1658 SerializeError::Deserialize(_) => Self::serialize_corruption(format!(
1659 "{payload_label} decode failed: {}",
1660 SerializeErrorKind::Deserialize
1661 )),
1662 SerializeError::Serialize(_) => Self::serialize_corruption(format!(
1663 "{payload_label} decode failed: {}",
1664 SerializeErrorKind::Serialize
1665 )),
1666 }
1667 }
1668
1669 #[cfg(feature = "sql")]
1672 pub(crate) fn query_unsupported_sql_feature(feature: &'static str) -> Self {
1673 let message = format!(
1674 "SQL query is not executable in this release: unsupported SQL feature: {feature}"
1675 );
1676
1677 Self {
1678 class: ErrorClass::Unsupported,
1679 origin: ErrorOrigin::Query,
1680 message,
1681 detail: Some(ErrorDetail::Query(
1682 QueryErrorDetail::UnsupportedSqlFeature { feature },
1683 )),
1684 }
1685 }
1686
1687 pub fn store_not_found(key: impl Into<String>) -> Self {
1688 let key = key.into();
1689
1690 Self {
1691 class: ErrorClass::NotFound,
1692 origin: ErrorOrigin::Store,
1693 message: format!("data key not found: {key}"),
1694 detail: Some(ErrorDetail::Store(StoreError::NotFound { key })),
1695 }
1696 }
1697
1698 pub fn unsupported_entity_path(path: impl Into<String>) -> Self {
1700 let path = path.into();
1701
1702 Self::new(
1703 ErrorClass::Unsupported,
1704 ErrorOrigin::Store,
1705 format!("unsupported entity path: '{path}'"),
1706 )
1707 }
1708
1709 #[must_use]
1710 pub const fn is_not_found(&self) -> bool {
1711 matches!(
1712 self.detail,
1713 Some(ErrorDetail::Store(StoreError::NotFound { .. }))
1714 )
1715 }
1716
1717 #[must_use]
1718 pub fn display_with_class(&self) -> String {
1719 format!("{}:{}: {}", self.origin, self.class, self.message)
1720 }
1721
1722 #[cold]
1724 #[inline(never)]
1725 pub(crate) fn index_plan_corruption(origin: ErrorOrigin, message: impl Into<String>) -> Self {
1726 let message = message.into();
1727 Self::new(
1728 ErrorClass::Corruption,
1729 origin,
1730 format!("corruption detected ({origin}): {message}"),
1731 )
1732 }
1733
1734 #[cold]
1736 #[inline(never)]
1737 pub(crate) fn index_plan_index_corruption(message: impl Into<String>) -> Self {
1738 Self::index_plan_corruption(ErrorOrigin::Index, message)
1739 }
1740
1741 #[cold]
1743 #[inline(never)]
1744 pub(crate) fn index_plan_store_corruption(message: impl Into<String>) -> Self {
1745 Self::index_plan_corruption(ErrorOrigin::Store, message)
1746 }
1747
1748 #[cold]
1750 #[inline(never)]
1751 pub(crate) fn index_plan_serialize_corruption(message: impl Into<String>) -> Self {
1752 Self::index_plan_corruption(ErrorOrigin::Serialize, message)
1753 }
1754
1755 pub(crate) fn index_plan_invariant(origin: ErrorOrigin, message: impl Into<String>) -> Self {
1757 let message = message.into();
1758 Self::new(
1759 ErrorClass::InvariantViolation,
1760 origin,
1761 format!("invariant violation detected ({origin}): {message}"),
1762 )
1763 }
1764
1765 pub(crate) fn index_plan_store_invariant(message: impl Into<String>) -> Self {
1767 Self::index_plan_invariant(ErrorOrigin::Store, message)
1768 }
1769
1770 pub(crate) fn index_violation(path: &str, index_fields: &[&str]) -> Self {
1772 Self::new(
1773 ErrorClass::Conflict,
1774 ErrorOrigin::Index,
1775 format!(
1776 "index constraint violation: {path} ({})",
1777 index_fields.join(", ")
1778 ),
1779 )
1780 }
1781}
1782
1783#[derive(Debug, ThisError)]
1791pub enum ErrorDetail {
1792 #[error("{0}")]
1793 Store(StoreError),
1794 #[error("{0}")]
1795 Query(QueryErrorDetail),
1796 }
1803
1804#[derive(Debug, ThisError)]
1812pub enum StoreError {
1813 #[error("key not found: {key}")]
1814 NotFound { key: String },
1815
1816 #[error("store corruption: {message}")]
1817 Corrupt { message: String },
1818
1819 #[error("store invariant violation: {message}")]
1820 InvariantViolation { message: String },
1821}
1822
1823#[derive(Debug, ThisError)]
1830pub enum QueryErrorDetail {
1831 #[error("unsupported SQL feature: {feature}")]
1832 UnsupportedSqlFeature { feature: &'static str },
1833}
1834
1835#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1842pub enum ErrorClass {
1843 Corruption,
1844 IncompatiblePersistedFormat,
1845 NotFound,
1846 Internal,
1847 Conflict,
1848 Unsupported,
1849 InvariantViolation,
1850}
1851
1852impl fmt::Display for ErrorClass {
1853 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1854 let label = match self {
1855 Self::Corruption => "corruption",
1856 Self::IncompatiblePersistedFormat => "incompatible_persisted_format",
1857 Self::NotFound => "not_found",
1858 Self::Internal => "internal",
1859 Self::Conflict => "conflict",
1860 Self::Unsupported => "unsupported",
1861 Self::InvariantViolation => "invariant_violation",
1862 };
1863 write!(f, "{label}")
1864 }
1865}
1866
1867#[derive(Clone, Copy, Debug, Eq, PartialEq)]
1874pub enum ErrorOrigin {
1875 Serialize,
1876 Store,
1877 Index,
1878 Identity,
1879 Query,
1880 Planner,
1881 Cursor,
1882 Recovery,
1883 Response,
1884 Executor,
1885 Interface,
1886}
1887
1888impl fmt::Display for ErrorOrigin {
1889 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1890 let label = match self {
1891 Self::Serialize => "serialize",
1892 Self::Store => "store",
1893 Self::Index => "index",
1894 Self::Identity => "identity",
1895 Self::Query => "query",
1896 Self::Planner => "planner",
1897 Self::Cursor => "cursor",
1898 Self::Recovery => "recovery",
1899 Self::Response => "response",
1900 Self::Executor => "executor",
1901 Self::Interface => "interface",
1902 };
1903 write!(f, "{label}")
1904 }
1905}