rubo4e 0.9.0

Rust implementation of the BO4E energy-market data standard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(
    feature = "strum",
    derive(strum::EnumString, strum::EnumIter, strum::IntoStaticStr)
)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
/// Wahlrecht der Prognosegrundlage der Marktlokation.
#[non_exhaustive]
pub enum WahlrechtPrognosegrundlage {
    #[cfg_attr(feature = "serde", serde(rename = "DURCH_LF"))]
    #[cfg_attr(feature = "strum", strum(serialize = "DURCH_LF"))]
    DurchLf,
    #[cfg_attr(feature = "serde", serde(rename = "DURCH_LF_NICHT_GEGEBEN"))]
    #[cfg_attr(feature = "strum", strum(serialize = "DURCH_LF_NICHT_GEGEBEN"))]
    DurchLfNichtGegeben,
    #[cfg_attr(feature = "serde", serde(rename = "NICHT_WEGEN_GROSSEN_VERBRAUCHS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NICHT_WEGEN_GROSSEN_VERBRAUCHS"))]
    NichtWegenGrossenVerbrauchs,
    #[cfg_attr(feature = "serde", serde(rename = "NICHT_WEGEN_EIGENVERBRAUCH"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NICHT_WEGEN_EIGENVERBRAUCH"))]
    NichtWegenEigenverbrauch,
    #[cfg_attr(feature = "serde", serde(rename = "NICHT_WEGEN_TAGES_VERBRAUCH"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NICHT_WEGEN_TAGES_VERBRAUCH"))]
    NichtWegenTagesVerbrauch,
    #[cfg_attr(feature = "serde", serde(rename = "NICHT_WEGEN_ENWG"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NICHT_WEGEN_ENWG"))]
    NichtWegenEnwg,
    /// Unknown or future variant — produced when deserializing a value
    /// that is not yet known to this version of the library.
    #[cfg_attr(feature = "serde", serde(other, rename = "UNKNOWN"))]
    #[cfg_attr(feature = "strum", strum(serialize = "UNKNOWN"))]
    Unknown,
}
impl WahlrechtPrognosegrundlage {
    /// All variants defined by the BO4E schema, in declaration order.
    ///
    /// Excludes the forward-compatibility [`WahlrechtPrognosegrundlage::Unknown`] catch-all, so this
    /// is exactly the set of values that appear on the wire.  Available **without**
    /// the `strum` feature — use it to drift-guard SQL `CHECK` lists and mappings.
    pub const VARIANTS: &'static [Self] = &[
        Self::DurchLf,
        Self::DurchLfNichtGegeben,
        Self::NichtWegenGrossenVerbrauchs,
        Self::NichtWegenEigenverbrauch,
        Self::NichtWegenTagesVerbrauch,
        Self::NichtWegenEnwg,
    ];
    /// Number of schema-defined variants (equal to `VARIANTS.len()`), excluding the
    /// [`WahlrechtPrognosegrundlage::Unknown`] catch-all.  Stable for this schema version.
    pub const COUNT: usize = Self::VARIANTS.len();
    /// Returns an iterator over all **known** variants of `WahlrechtPrognosegrundlage`.
    ///
    /// Yields only variants that correspond to values defined in the BO4E schema
    /// (i.e. [`Self::VARIANTS`]), never the [`WahlrechtPrognosegrundlage::Unknown`] catch-all.
    /// Available **without** the `strum` feature.
    ///
    /// # Example
    /// ```
    /// # use rubo4e::current::WahlrechtPrognosegrundlage;
    /// // Never yields the `Unknown` catch-all, so the count matches `COUNT`.
    /// assert_eq!(WahlrechtPrognosegrundlage::iter_known().count(), WahlrechtPrognosegrundlage::COUNT);
    /// assert!(WahlrechtPrognosegrundlage::iter_known().all(|v| v.is_known()));
    /// ```
    pub fn iter_known() -> impl Iterator<Item = Self> + Clone {
        Self::VARIANTS.iter().copied()
    }
    /// Returns the canonical BO4E wire string (SCREAMING_SNAKE_CASE) for this value.
    ///
    /// [`WahlrechtPrognosegrundlage::Unknown`] renders as `"UNKNOWN"`, matching its serialized form.
    pub const fn as_wire(&self) -> &'static str {
        match self {
            Self::DurchLf => "DURCH_LF",
            Self::DurchLfNichtGegeben => "DURCH_LF_NICHT_GEGEBEN",
            Self::NichtWegenGrossenVerbrauchs => "NICHT_WEGEN_GROSSEN_VERBRAUCHS",
            Self::NichtWegenEigenverbrauch => "NICHT_WEGEN_EIGENVERBRAUCH",
            Self::NichtWegenTagesVerbrauch => "NICHT_WEGEN_TAGES_VERBRAUCH",
            Self::NichtWegenEnwg => "NICHT_WEGEN_ENWG",
            Self::Unknown => "UNKNOWN",
        }
    }
    /// **Strictly** parses a BO4E wire string into a known variant.
    ///
    /// Unlike the lenient `serde` / [`FromStr`](std::str::FromStr) path — which maps
    /// any unrecognized value (a typo, a legacy code, or a value from a newer schema)
    /// to [`WahlrechtPrognosegrundlage::Unknown`] — this returns
    /// [`Err`](crate::error::UnknownVariant) for values not defined in this schema
    /// version, including the literal `"UNKNOWN"`.  Use it at the ingest boundary to
    /// reject bad values instead of silently degrading them.
    ///
    /// # Example
    /// ```
    /// # use rubo4e::current::WahlrechtPrognosegrundlage;
    /// /// assert_eq!(WahlrechtPrognosegrundlage::from_wire("DURCH_LF"), Ok(WahlrechtPrognosegrundlage::DurchLf));
    /// assert!(WahlrechtPrognosegrundlage::from_wire("NOT_A_REAL_VALUE").is_err());
    /// // …including the `Unknown` catch-all's own wire spelling:
    /// assert!(WahlrechtPrognosegrundlage::from_wire("UNKNOWN").is_err());
    /// ```
    pub fn from_wire(s: &str) -> Result<Self, crate::error::UnknownVariant> {
        match s {
            "DURCH_LF" => Ok(Self::DurchLf),
            "DURCH_LF_NICHT_GEGEBEN" => Ok(Self::DurchLfNichtGegeben),
            "NICHT_WEGEN_GROSSEN_VERBRAUCHS" => Ok(Self::NichtWegenGrossenVerbrauchs),
            "NICHT_WEGEN_EIGENVERBRAUCH" => Ok(Self::NichtWegenEigenverbrauch),
            "NICHT_WEGEN_TAGES_VERBRAUCH" => Ok(Self::NichtWegenTagesVerbrauch),
            "NICHT_WEGEN_ENWG" => Ok(Self::NichtWegenEnwg),
            other => Err(crate::error::UnknownVariant::new(other)),
        }
    }
    /// Returns `true` if this value is the forward-compatibility
    /// [`WahlrechtPrognosegrundlage::Unknown`] catch-all (an out-of-schema value).
    pub const fn is_unknown(&self) -> bool {
        matches!(self, Self::Unknown)
    }
    /// Returns `true` if this value is a known, schema-defined variant.
    pub const fn is_known(&self) -> bool {
        !self.is_unknown()
    }
}
impl std::fmt::Display for WahlrechtPrognosegrundlage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_wire())
    }
}
impl AsRef<str> for WahlrechtPrognosegrundlage {
    fn as_ref(&self) -> &str {
        self.as_wire()
    }
}
#[cfg(feature = "versioned")]
impl crate::bo4e_enum_sealed::Sealed for WahlrechtPrognosegrundlage {}
#[cfg(feature = "versioned")]
impl crate::Bo4eEnum for WahlrechtPrognosegrundlage {
    const VARIANTS: &'static [Self] = Self::VARIANTS;
    const COUNT: usize = Self::COUNT;
    fn as_wire(&self) -> &'static str {
        Self::as_wire(self)
    }
    fn from_wire(s: &str) -> Result<Self, crate::error::UnknownVariant> {
        Self::from_wire(s)
    }
    fn is_unknown(&self) -> bool {
        Self::is_unknown(self)
    }
}
#[cfg(feature = "versioned")]
impl crate::Bo4eStrict for WahlrechtPrognosegrundlage {
    fn collect_unknown_enums(&self, path: &str, out: &mut Vec<String>) {
        if self.is_unknown() {
            out.push(path.to_owned());
        }
    }
}
#[cfg(feature = "sqlx")]
impl sqlx::Type<sqlx::Postgres> for WahlrechtPrognosegrundlage {
    fn type_info() -> sqlx::postgres::PgTypeInfo {
        <String as sqlx::Type<sqlx::Postgres>>::type_info()
    }
}
/// Encodes as the canonical BO4E wire string, borrowed from `as_wire` — no
/// intermediate `String` or `serde_json::Value` is allocated.
#[cfg(feature = "sqlx")]
impl<'q> sqlx::Encode<'q, sqlx::Postgres> for WahlrechtPrognosegrundlage {
    fn encode_by_ref(
        &self,
        buf: &mut <sqlx::Postgres as sqlx::Database>::ArgumentBuffer<'q>,
    ) -> Result<sqlx::encode::IsNull, sqlx::error::BoxDynError> {
        let s: &str = self.as_wire();
        <&str as sqlx::Encode<'q, sqlx::Postgres>>::encode_by_ref(&s, buf)
    }
}
/// Decodes leniently, matching the `serde` path: a value the schema does not
/// define becomes [`WahlrechtPrognosegrundlage::Unknown`] rather than a decode error, so a
/// database row written by a newer schema version still reads back.
///
/// Use [`WahlrechtPrognosegrundlage::from_wire`] on a `String` column, or check
/// [`WahlrechtPrognosegrundlage::is_known`], where out-of-schema values must be rejected.
#[cfg(feature = "sqlx")]
impl<'r> sqlx::Decode<'r, sqlx::Postgres> for WahlrechtPrognosegrundlage {
    fn decode(
        value: <sqlx::Postgres as sqlx::Database>::ValueRef<'r>,
    ) -> Result<Self, sqlx::error::BoxDynError> {
        let s = <&str as sqlx::Decode<sqlx::Postgres>>::decode(value)?;
        Ok(Self::from_wire(s).unwrap_or(Self::Unknown))
    }
}
#[cfg(test)]
impl proptest::arbitrary::Arbitrary for WahlrechtPrognosegrundlage {
    type Parameters = ();
    type Strategy = proptest::strategy::BoxedStrategy<Self>;
    fn arbitrary_with(_: Self::Parameters) -> Self::Strategy {
        use proptest::prelude::*;
        proptest::sample::select(Self::VARIANTS.to_vec()).boxed()
    }
}