Skip to main content

canwu_sim/runtime/
error.rs

1use super::EntityRef;
2use serde::{Deserialize, Serialize};
3use std::error::Error;
4use std::fmt::{Display, Formatter};
5
6#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
7#[serde(rename_all = "snake_case")]
8pub enum ErrorCode {
9    ActorNotFound,
10    ArchiveNotReady,
11    ArmyNotFound,
12    DestinationNotFound,
13    DuplicateBoundaryWriter,
14    DuplicateDomainRecord,
15    DuplicateDomainRecordKind,
16    DuplicatePlugin,
17    DuplicatePluginCommand,
18    DuplicatePluginIngress,
19    DuplicatePluginSystem,
20    DuplicateStateOwner,
21    DuplicateReservationOfferer,
22    EntityNotFound,
23    DomainRecordNotFound,
24    DomainRecordReferenced,
25    DomainRecordVersionConflict,
26    InvalidAuthority,
27    InvalidArchive,
28    InvalidBoundary,
29    InvalidDecision,
30    InvalidDuration,
31    InvalidDomainRecord,
32    InvalidKnowledgeHolder,
33    InvalidKnowledgeRecord,
34    InvalidKnowledgeSchema,
35    InvalidKnowledgeAuthority,
36    KnowledgeLimitExceeded,
37    KnowledgeReadCutUnavailable,
38    KnowledgeRecordNotFound,
39    UndeclaredKnowledgeWrite,
40    EvidenceUnavailable,
41    EvidenceContentUnavailable,
42    DuplicateKnowledgeRecordKind,
43    InvalidRandomOperationEvidence,
44    RandomOperationConflict,
45    IdempotencyConflict,
46    InteractionReadOnly,
47    InvalidPayload,
48    InvalidPluginRegistration,
49    InvalidRandomDraw,
50    InvalidRandomStream,
51    InvalidRunConfiguration,
52    InvalidRunManifest,
53    InvalidSnapshot,
54    IdentifierExhausted,
55    LegacyReplayUnavailable,
56    LateIngress,
57    MissingIdempotencyKey,
58    MixedCommandIngress,
59    NoRoute,
60    PluginCommandNotFound,
61    PluginManifestMismatch,
62    PluginNotActive,
63    PluginPanicked,
64    PluginRegistrationClosed,
65    QueryBudgetExceeded,
66    ReplayMismatch,
67    ReplayEnvironmentMismatch,
68    SimulationRevisionConflict,
69    SimulationTimeConflict,
70    StaleSealToken,
71    StatePageUnavailable,
72    SynchronousReactionLimit,
73    UndeclaredRandomStream,
74    UndeclaredStateRead,
75    UndeclaredStateWrite,
76    UnsupportedSnapshotVersion,
77    UnsupportedRandomDrawAddress,
78    ValueOutOfRange,
79    /// A command or decision issuer resolves to a person who is not alive or
80    /// is detained or captive.
81    IssuerUnavailable,
82    /// A decision maker resolves to a person who is not alive or is detained
83    /// or captive.
84    DecisionMakerUnavailable,
85}
86
87#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
88pub struct CanwuError {
89    pub code: ErrorCode,
90    pub message: String,
91    pub related_entities: Vec<EntityRef>,
92}
93
94impl CanwuError {
95    #[must_use]
96    pub fn new(code: ErrorCode, message: impl Into<String>) -> Self {
97        Self {
98            code,
99            message: message.into(),
100            related_entities: Vec::new(),
101        }
102    }
103
104    #[must_use]
105    pub fn with_entity(mut self, entity: EntityRef) -> Self {
106        self.related_entities.push(entity);
107        self
108    }
109}
110
111impl Display for CanwuError {
112    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
113        write!(
114            formatter,
115            "{}: {}",
116            error_code_name(&self.code),
117            self.message
118        )
119    }
120}
121
122impl Error for CanwuError {}
123
124const fn error_code_name(code: &ErrorCode) -> &'static str {
125    match code {
126        ErrorCode::ActorNotFound => "actor_not_found",
127        ErrorCode::ArchiveNotReady => "archive_not_ready",
128        ErrorCode::ArmyNotFound => "army_not_found",
129        ErrorCode::DestinationNotFound => "destination_not_found",
130        ErrorCode::DuplicateBoundaryWriter => "duplicate_boundary_writer",
131        ErrorCode::DuplicateDomainRecord => "duplicate_domain_record",
132        ErrorCode::DuplicateDomainRecordKind => "duplicate_domain_record_kind",
133        ErrorCode::DuplicatePlugin => "duplicate_plugin",
134        ErrorCode::DuplicatePluginCommand => "duplicate_plugin_command",
135        ErrorCode::DuplicatePluginIngress => "duplicate_plugin_ingress",
136        ErrorCode::DuplicatePluginSystem => "duplicate_plugin_system",
137        ErrorCode::DuplicateStateOwner => "duplicate_state_owner",
138        ErrorCode::DuplicateReservationOfferer => "duplicate_reservation_offerer",
139        ErrorCode::EntityNotFound => "entity_not_found",
140        ErrorCode::DomainRecordNotFound => "domain_record_not_found",
141        ErrorCode::DomainRecordReferenced => "domain_record_referenced",
142        ErrorCode::DomainRecordVersionConflict => "domain_record_version_conflict",
143        ErrorCode::InvalidAuthority => "invalid_authority",
144        ErrorCode::InvalidArchive => "invalid_archive",
145        ErrorCode::InvalidBoundary => "invalid_boundary",
146        ErrorCode::InvalidDecision => "invalid_decision",
147        ErrorCode::InvalidDuration => "invalid_duration",
148        ErrorCode::InvalidDomainRecord => "invalid_domain_record",
149        ErrorCode::InvalidKnowledgeHolder => "invalid_knowledge_holder",
150        ErrorCode::InvalidKnowledgeRecord => "invalid_knowledge_record",
151        ErrorCode::InvalidKnowledgeSchema => "invalid_knowledge_schema",
152        ErrorCode::InvalidKnowledgeAuthority => "invalid_knowledge_authority",
153        ErrorCode::KnowledgeLimitExceeded => "knowledge_limit_exceeded",
154        ErrorCode::KnowledgeReadCutUnavailable => "knowledge_read_cut_unavailable",
155        ErrorCode::KnowledgeRecordNotFound => "knowledge_record_not_found",
156        ErrorCode::UndeclaredKnowledgeWrite => "undeclared_knowledge_write",
157        ErrorCode::EvidenceUnavailable => "evidence_unavailable",
158        ErrorCode::EvidenceContentUnavailable => "evidence_content_unavailable",
159        ErrorCode::DuplicateKnowledgeRecordKind => "duplicate_knowledge_record_kind",
160        ErrorCode::InvalidRandomOperationEvidence => "invalid_random_operation_evidence",
161        ErrorCode::RandomOperationConflict => "random_operation_conflict",
162        ErrorCode::IdempotencyConflict => "idempotency_conflict",
163        ErrorCode::InteractionReadOnly => "interaction_read_only",
164        ErrorCode::InvalidPayload => "invalid_payload",
165        ErrorCode::InvalidPluginRegistration => "invalid_plugin_registration",
166        ErrorCode::InvalidRandomDraw => "invalid_random_draw",
167        ErrorCode::InvalidRandomStream => "invalid_random_stream",
168        ErrorCode::InvalidRunConfiguration => "invalid_run_configuration",
169        ErrorCode::InvalidRunManifest => "invalid_run_manifest",
170        ErrorCode::InvalidSnapshot => "invalid_snapshot",
171        ErrorCode::IdentifierExhausted => "identifier_exhausted",
172        ErrorCode::LegacyReplayUnavailable => "legacy_replay_unavailable",
173        ErrorCode::LateIngress => "late_ingress",
174        ErrorCode::MissingIdempotencyKey => "missing_idempotency_key",
175        ErrorCode::MixedCommandIngress => "mixed_command_ingress",
176        ErrorCode::NoRoute => "no_route",
177        ErrorCode::PluginCommandNotFound => "plugin_command_not_found",
178        ErrorCode::PluginManifestMismatch => "plugin_manifest_mismatch",
179        ErrorCode::PluginNotActive => "plugin_not_active",
180        ErrorCode::PluginPanicked => "plugin_panicked",
181        ErrorCode::PluginRegistrationClosed => "plugin_registration_closed",
182        ErrorCode::QueryBudgetExceeded => "query_budget_exceeded",
183        ErrorCode::ReplayMismatch => "replay_mismatch",
184        ErrorCode::ReplayEnvironmentMismatch => "replay_environment_mismatch",
185        ErrorCode::SimulationRevisionConflict => "simulation_revision_conflict",
186        ErrorCode::SimulationTimeConflict => "simulation_time_conflict",
187        ErrorCode::StaleSealToken => "stale_seal_token",
188        ErrorCode::StatePageUnavailable => "state_page_unavailable",
189        ErrorCode::SynchronousReactionLimit => "synchronous_reaction_limit",
190        ErrorCode::UndeclaredRandomStream => "undeclared_random_stream",
191        ErrorCode::UndeclaredStateRead => "undeclared_state_read",
192        ErrorCode::UndeclaredStateWrite => "undeclared_state_write",
193        ErrorCode::UnsupportedSnapshotVersion => "unsupported_snapshot_version",
194        ErrorCode::UnsupportedRandomDrawAddress => "unsupported_random_draw_address",
195        ErrorCode::ValueOutOfRange => "value_out_of_range",
196        ErrorCode::IssuerUnavailable => "issuer_unavailable",
197        ErrorCode::DecisionMakerUnavailable => "decision_maker_unavailable",
198    }
199}