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

#[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))]
/// Klassifiziert einen Tagtyp, an dem ein wiederkehrendes Schaltschema (z.B. die Umschaltzeiten einer
/// `Zaehlzeitdefinition`) gilt. Die Werte teilen sich in drei Gruppen auf:
///
/// * `TAEGLICH` – gilt an jedem Tag des Jahres.
/// * Gruppenbezeichnungen (`WERKTAGS`, `WOCHENENDE`, `FEIERTAGS`) – fassen mehrere Wochentage zusammen.
///   Was als Feiertag zählt, wird durch den Feiertagskalender der `Zaehlzeitdefinition` bestimmt.
/// * Einzelne Wochentage (`MONTAGS` … `SONNTAGS`).
#[non_exhaustive]
pub enum Wiederholungstyp {
    #[cfg_attr(feature = "serde", serde(rename = "TAEGLICH"))]
    #[cfg_attr(feature = "strum", strum(serialize = "TAEGLICH"))]
    Taeglich,
    #[cfg_attr(feature = "serde", serde(rename = "WERKTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "WERKTAGS"))]
    Werktags,
    #[cfg_attr(feature = "serde", serde(rename = "WOCHENENDE"))]
    #[cfg_attr(feature = "strum", strum(serialize = "WOCHENENDE"))]
    Wochenende,
    #[cfg_attr(feature = "serde", serde(rename = "FEIERTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "FEIERTAGS"))]
    Feiertags,
    #[cfg_attr(feature = "serde", serde(rename = "MONTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MONTAGS"))]
    Montags,
    #[cfg_attr(feature = "serde", serde(rename = "DIENSTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "DIENSTAGS"))]
    Dienstags,
    #[cfg_attr(feature = "serde", serde(rename = "MITTWOCHS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "MITTWOCHS"))]
    Mittwochs,
    #[cfg_attr(feature = "serde", serde(rename = "DONNERSTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "DONNERSTAGS"))]
    Donnerstags,
    #[cfg_attr(feature = "serde", serde(rename = "FREITAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "FREITAGS"))]
    Freitags,
    #[cfg_attr(feature = "serde", serde(rename = "SAMSTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "SAMSTAGS"))]
    Samstags,
    #[cfg_attr(feature = "serde", serde(rename = "SONNTAGS"))]
    #[cfg_attr(feature = "strum", strum(serialize = "SONNTAGS"))]
    Sonntags,
    /// 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 Wiederholungstyp {
    /// Returns an iterator over all **known** variants of `Wiederholungstyp`.
    ///
    /// Unlike [`strum::IntoEnumIterator`] which includes the [`Wiederholungstyp::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 Wiederholungstyp::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 Wiederholungstyp {
    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 Wiederholungstyp {
    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 Wiederholungstyp {
    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 Wiederholungstyp {
    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 Wiederholungstyp {
    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()
    }
}