rubo4e 0.5.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

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(
    feature = "strum",
    derive(
        strum::Display,
        strum::EnumString,
        strum::EnumIter,
        strum::IntoStaticStr,
        strum::AsRefStr
    )
)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
/// Klassifizierung der Kriterien für eine regionale Eingrenzung.
#[non_exhaustive]
pub enum Regionskriterium {
    #[cfg_attr(feature = "serde", serde(rename = "BUNDESLANDKENNZIFFER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "BUNDESLANDKENNZIFFER"))]
    Bundeslandkennziffer,
    #[cfg_attr(feature = "serde", serde(rename = "BUNDESLAND_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "BUNDESLAND_NAME"))]
    BundeslandName,
    #[cfg_attr(feature = "serde", serde(rename = "MARKTGEBIET_NUMMER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MARKTGEBIET_NUMMER"))]
    MarktgebietNummer,
    #[cfg_attr(feature = "serde", serde(rename = "MARKTGEBIET_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MARKTGEBIET_NAME"))]
    MarktgebietName,
    #[cfg_attr(feature = "serde", serde(rename = "REGELGEBIET_NUMMER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "REGELGEBIET_NUMMER"))]
    RegelgebietNummer,
    #[cfg_attr(feature = "serde", serde(rename = "REGELGEBIET_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "REGELGEBIET_NAME"))]
    RegelgebietName,
    #[cfg_attr(feature = "serde", serde(rename = "NETZ_STROM"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZ_STROM"))]
    NetzStrom,
    #[cfg_attr(feature = "serde", serde(rename = "NETZ_GAS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZ_GAS"))]
    NetzGas,
    #[cfg_attr(feature = "serde", serde(rename = "NETZBETREIBER_NUMMER_STROM"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZBETREIBER_NUMMER_STROM"))]
    NetzbetreiberNummerStrom,
    #[cfg_attr(feature = "serde", serde(rename = "NETZBETREIBER_NUMMER_GAS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZBETREIBER_NUMMER_GAS"))]
    NetzbetreiberNummerGas,
    #[cfg_attr(feature = "serde", serde(rename = "NETZBETREIBER_NAME_STROM"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZBETREIBER_NAME_STROM"))]
    NetzbetreiberNameStrom,
    #[cfg_attr(feature = "serde", serde(rename = "NETZBETREIBER_NAME_GAS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "NETZBETREIBER_NAME_GAS"))]
    NetzbetreiberNameGas,
    #[cfg_attr(feature = "serde", serde(rename = "BILANZIERUNGS_GEBIET_NUMMER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "BILANZIERUNGS_GEBIET_NUMMER"))]
    BilanzierungsGebietNummer,
    #[cfg_attr(feature = "serde", serde(rename = "MSB_NUMMER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MSB_NUMMER"))]
    MsbNummer,
    #[cfg_attr(feature = "serde", serde(rename = "MSB_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MSB_NAME"))]
    MsbName,
    #[cfg_attr(feature = "serde", serde(rename = "VERSORGER_NUMMER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "VERSORGER_NUMMER"))]
    VersorgerNummer,
    #[cfg_attr(feature = "serde", serde(rename = "VERSORGER_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "VERSORGER_NAME"))]
    VersorgerName,
    #[cfg_attr(feature = "serde", serde(rename = "GRUNDVERSORGER_NUMMER_STROM"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GRUNDVERSORGER_NUMMER_STROM"))]
    GrundversorgerNummerStrom,
    #[cfg_attr(feature = "serde", serde(rename = "GRUNDVERSORGER_NAME_STROM"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GRUNDVERSORGER_NAME_STROM"))]
    GrundversorgerNameStrom,
    #[cfg_attr(feature = "serde", serde(rename = "GRUNDVERSORGER_NUMMER_GAS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GRUNDVERSORGER_NUMMER_GAS"))]
    GrundversorgerNummerGas,
    #[cfg_attr(feature = "serde", serde(rename = "GRUNDVERSORGER_NAME_GAS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GRUNDVERSORGER_NAME_GAS"))]
    GrundversorgerNameGas,
    #[cfg_attr(feature = "serde", serde(rename = "KREIS_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "KREIS_NAME"))]
    KreisName,
    #[cfg_attr(feature = "serde", serde(rename = "KREISKENNZIFFER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "KREISKENNZIFFER"))]
    Kreiskennziffer,
    #[cfg_attr(feature = "serde", serde(rename = "GEMEINDE_NAME"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GEMEINDE_NAME"))]
    GemeindeName,
    #[cfg_attr(feature = "serde", serde(rename = "GEMEINDEKENNZIFFER"))]
    #[cfg_attr(feature = "strum", strum(serialize = "GEMEINDEKENNZIFFER"))]
    Gemeindekennziffer,
    #[cfg_attr(feature = "serde", serde(rename = "POSTLEITZAHL"))]
    #[cfg_attr(feature = "strum", strum(serialize = "POSTLEITZAHL"))]
    Postleitzahl,
    #[cfg_attr(feature = "serde", serde(rename = "ORT"))]
    #[cfg_attr(feature = "strum", strum(serialize = "ORT"))]
    Ort,
    #[cfg_attr(feature = "serde", serde(rename = "POSTORT"))]
    #[cfg_attr(feature = "strum", strum(serialize = "POSTORT"))]
    Postort,
    #[cfg_attr(feature = "serde", serde(rename = "EINWOHNERZAHL_GEMEINDE"))]
    #[cfg_attr(feature = "strum", strum(serialize = "EINWOHNERZAHL_GEMEINDE"))]
    EinwohnerzahlGemeinde,
    #[cfg_attr(feature = "serde", serde(rename = "EINWOHNERZAHL_ORT"))]
    #[cfg_attr(feature = "strum", strum(serialize = "EINWOHNERZAHL_ORT"))]
    EinwohnerzahlOrt,
    #[cfg_attr(feature = "serde", serde(rename = "PLZ_KM_UMKREIS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "PLZ_KM_UMKREIS"))]
    PlzKmUmkreis,
    #[cfg_attr(feature = "serde", serde(rename = "BUNDESWEIT"))]
    #[cfg_attr(feature = "strum", strum(serialize = "BUNDESWEIT"))]
    Bundesweit,
    #[cfg_attr(feature = "serde", serde(rename = "PLZ_BEREICH"))]
    #[cfg_attr(feature = "strum", strum(serialize = "PLZ_BEREICH"))]
    PlzBereich,
    /// 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 Regionskriterium {
    /// Returns an iterator over all **known** variants of `Regionskriterium`.
    ///
    /// Unlike [`strum::IntoEnumIterator`] which includes the [`Regionskriterium::Unknown`]
    /// catch-all, this method yields only variants that correspond to values defined
    /// in the BO4E schema.  Use this when building dropdowns, lookup tables, or
    /// generating reports that should only include valid schema values.
    ///
    /// # Example
    /// ```rust,ignore
    /// for v in Regionskriterium::iter_known() {
    ///     println!("{v}");
    /// }
    /// ```
    #[cfg(feature = "strum")]
    pub fn iter_known() -> impl Iterator<Item = Self> {
        use strum::IntoEnumIterator as _;
        Self::iter().filter(|v| !matches!(v, Self::Unknown))
    }
}
#[cfg(all(feature = "sqlx", feature = "json"))]
impl sqlx::Type<sqlx::Postgres> for Regionskriterium {
    fn type_info() -> sqlx::postgres::PgTypeInfo {
        <String as sqlx::Type<sqlx::Postgres>>::type_info()
    }
}
/// Strum fast path: `AsRef<str>` returns the canonical string without a
/// `serde_json::Value` intermediate, saving an allocation per encode (M-07).
#[cfg(all(feature = "sqlx", feature = "json", feature = "strum"))]
impl<'q> sqlx::Encode<'q, sqlx::Postgres> for Regionskriterium {
    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_ref();
        <&str as sqlx::Encode<'q, sqlx::Postgres>>::encode_by_ref(&s, buf)
    }
}
/// Fallback when `strum` is not active: serialize via `serde_json`.
#[cfg(all(feature = "sqlx", feature = "json", not(feature = "strum")))]
impl<'q> sqlx::Encode<'q, sqlx::Postgres> for Regionskriterium {
    fn encode_by_ref(
        &self,
        buf: &mut <sqlx::Postgres as sqlx::Database>::ArgumentBuffer<'q>,
    ) -> Result<sqlx::encode::IsNull, sqlx::error::BoxDynError> {
        let s = serde_json::to_value(self)?
            .as_str()
            .ok_or("enum variant did not serialize to a JSON string")?
            .to_owned();
        <String as sqlx::Encode<'q, sqlx::Postgres>>::encode_by_ref(&s, buf)
    }
}
#[cfg(all(feature = "sqlx", feature = "json"))]
impl<'r> sqlx::Decode<'r, sqlx::Postgres> for Regionskriterium {
    fn decode(
        value: <sqlx::Postgres as sqlx::Database>::ValueRef<'r>,
    ) -> Result<Self, sqlx::error::BoxDynError> {
        let s = <String as sqlx::Decode<sqlx::Postgres>>::decode(value)?;
        serde_json::from_value(serde_json::Value::String(s))
            .map_err(|e| Box::new(e) as sqlx::error::BoxDynError)
    }
}
#[cfg(all(test, feature = "strum"))]
impl proptest::arbitrary::Arbitrary for Regionskriterium {
    type Parameters = ();
    type Strategy = proptest::strategy::BoxedStrategy<Self>;
    fn arbitrary_with(_: Self::Parameters) -> Self::Strategy {
        use proptest::prelude::*;
        use strum::IntoEnumIterator as _;
        let variants: Vec<Self> = Self::iter().collect();
        proptest::sample::select(variants).boxed()
    }
}