Skip to main content

ed_journals/modules/exploration/models/
codex_guardian_entry.rs

1use crate::exploration::shared::codex_regex::CODEX_REGEX;
2use crate::from_str_deserialize_impl;
3use serde::Serialize;
4use std::fmt::{Display, Formatter};
5use std::str::FromStr;
6use thiserror::Error;
7
8#[derive(Debug, Serialize, Clone, PartialEq, Eq, Hash)]
9#[cfg_attr(not(feature = "allow-unknown"), non_exhaustive)]
10pub enum CodexGuardianEntry {
11    AncientCasket,
12    AncientKey,
13    AncientOrb,
14    AncientRelic,
15    AncientRelics,
16    AncientTablet,
17    AncientTotem,
18    AncientUrn,
19
20    GuardianBeacons,
21    GuardianDataBank,
22    GuardianDataLogs,
23    GuardianPad,
24    GuardianPylon,
25    GuardianSentinel,
26    GuardianTerminal,
27
28    #[cfg(feature = "allow-unknown")]
29    #[cfg_attr(docsrs, doc(cfg(feature = "allow-unknown")))]
30    Unknown(String),
31}
32
33impl CodexGuardianEntry {
34    /// Whether the current variant is unknown.
35    #[cfg(feature = "allow-unknown")]
36    #[cfg_attr(docsrs, doc(cfg(feature = "allow-unknown")))]
37    pub fn is_unknown(&self) -> bool {
38        matches!(self, CodexGuardianEntry::Unknown(_))
39    }
40}
41
42#[derive(Debug, Error)]
43pub enum CodexGuardianError {
44    #[error("Failed to parse guardian codex entry: '{0}'")]
45    FailedToParse(String),
46
47    #[error("Unknown guardian codex entry: '{0}'")]
48    UnknownEntry(String),
49}
50
51impl FromStr for CodexGuardianEntry {
52    type Err = CodexGuardianError;
53
54    fn from_str(s: &str) -> Result<Self, Self::Err> {
55        let Some(captures) = CODEX_REGEX.captures(s) else {
56            return Err(CodexGuardianError::FailedToParse(s.to_string()));
57        };
58
59        let string: &str = &captures
60            .get(1)
61            .expect("Should have been captured already")
62            .as_str()
63            .to_ascii_lowercase();
64
65        Ok(match string {
66            "ancient_casket" => CodexGuardianEntry::AncientCasket,
67            "ancient_key" => CodexGuardianEntry::AncientKey,
68            "ancient_orb" => CodexGuardianEntry::AncientOrb,
69            "ancient_relic" => CodexGuardianEntry::AncientRelic,
70            "ancient_relics" => CodexGuardianEntry::AncientRelics,
71            "ancient_tablet" => CodexGuardianEntry::AncientTablet,
72            "ancient_totem" => CodexGuardianEntry::AncientTotem,
73            "ancient_urn" => CodexGuardianEntry::AncientUrn,
74
75            "guardian_beacons" => CodexGuardianEntry::GuardianBeacons,
76            "guardian_data_bank" => CodexGuardianEntry::GuardianDataBank,
77            "guardian_data_logs" => CodexGuardianEntry::GuardianDataLogs,
78            "guardian_pad" => CodexGuardianEntry::GuardianPad,
79            "guardian_pylon" => CodexGuardianEntry::GuardianPylon,
80            "guardian_sentinel" => CodexGuardianEntry::GuardianSentinel,
81            "guardian_terminal" => CodexGuardianEntry::GuardianTerminal,
82
83            #[cfg(feature = "allow-unknown")]
84            _ => CodexGuardianEntry::Unknown(string.to_string()),
85
86            #[cfg(not(feature = "allow-unknown"))]
87            _ => return Err(CodexGuardianError::UnknownEntry(string.to_string())),
88        })
89    }
90}
91
92from_str_deserialize_impl!(CodexGuardianEntry);
93
94impl Display for CodexGuardianEntry {
95    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
96        write!(
97            f,
98            "{}",
99            match self {
100                CodexGuardianEntry::AncientCasket => "Ancient Casket",
101                CodexGuardianEntry::AncientKey => "Ancient Key",
102                CodexGuardianEntry::AncientOrb => "Ancient Orb",
103                CodexGuardianEntry::AncientRelic => "Ancient Relic",
104                CodexGuardianEntry::AncientRelics => "Ancient Relics",
105                CodexGuardianEntry::AncientTablet => "Ancient Tablet",
106                CodexGuardianEntry::AncientTotem => "Ancient Totem",
107                CodexGuardianEntry::AncientUrn => "Ancient Urn",
108
109                CodexGuardianEntry::GuardianBeacons => "Guardian Beacons",
110                CodexGuardianEntry::GuardianDataBank => "Guardian Data Bank",
111                CodexGuardianEntry::GuardianDataLogs => "Guardian Data Logs",
112                CodexGuardianEntry::GuardianPad => "Guardian Pad",
113                CodexGuardianEntry::GuardianPylon => "Guardian Pylon",
114                CodexGuardianEntry::GuardianSentinel => "Guardian Sentinel",
115                CodexGuardianEntry::GuardianTerminal => "Guardian Terminal",
116
117                #[cfg(feature = "allow-unknown")]
118                CodexGuardianEntry::Unknown(unknown) =>
119                    return write!(f, "Unknown guardian codex entry: {unknown}"),
120            }
121        )
122    }
123}