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

use super::{Bo4eObject, BoTyp, Marktteilnehmer, Zaehlzeitsaison, ZusatzAttribut};
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(not(feature = "json"), derive(Eq, Hash))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[cfg_attr(feature = "validate", derive(garde::Validate))]
#[cfg_attr(feature = "validate", garde(allow_unvalidated))]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
/// Beschreibt, zu welchen Zeiten welche Register aktiv sind.
///
/// Die `Zaehlzeitdefinition` ist unabhängig von konkreter Messhardware: sie weiß nichts über
/// `Zaehlwerk`e oder `Zaehler` an einer Messlokation und definiert lediglich abstrakt, welche
/// Register-Codes (z.B. "HT", "NT", aber prinzipiell beliebige freie Zeichenketten) zu welchen
/// Tageszeiten gelten.
///
/// Die zeitliche Modellierung ist dreistufig geschachtelt:
///
/// 1. ``saisons`` – ein Jahr kann in unterschiedliche Saisons aufgeteilt sein (z.B. Sommer/Winter).
///    Welche Tage zu welcher Saison gehören, gibt das `saisonprofil` an.
/// 2. Pro Saison: ``tagtypen`` – verschiedene Tagtypen (z.B. Werktag, Wochenende, Feiertag)
///    können unterschiedliche Schaltschemata haben. Welche Tage als Feiertag gelten, gibt der
///    `feiertagskalender` an.
/// 3. Pro Tagtyp: ``umschaltzeiten`` – die eigentlichen Uhrzeiten, zu denen auf welches Register
///    umgeschaltet wird.
///
/// > **Note:** [Zaehlzeitdefinition JSON Schema](https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/v202607.1.0/src/bo4e_schemas/bo/Zaehlzeitdefinition.json)
pub struct Zaehlzeitdefinition {
    /// Bezeichnung des Feiertagskalenders, nach dem `FEIERTAGS`-Tagtypen aufgelöst werden (z.B. "BDEW",
    /// landes- oder gemeindespezifische Kalender). Frei wählbare Zeichenkette, deren Bedeutung zwischen
    /// den Marktpartnern abgestimmt sein muss.
    #[cfg_attr(feature = "serde", serde(rename = "feiertagskalender"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    pub feiertagskalender: Option<String>,
    /// Eine generische ID, die für eigene Zwecke genutzt werden kann.
    /// Z.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.
    #[cfg_attr(feature = "serde", serde(rename = "_id"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    pub id: Option<String>,
    /// Bezeichnung des Saisonprofils, das die Datumsgrenzen der in `saisons` referenzierten Saisons
    /// festlegt (z.B. "Sommer/Winter").
    #[cfg_attr(feature = "serde", serde(rename = "saisonprofil"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    pub saisonprofil: Option<String>,
    /// Die Schaltschemata, gruppiert nach Saison.
    #[cfg_attr(feature = "serde", serde(rename = "saisons"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    #[cfg_attr(feature = "validate", garde(dive))]
    pub saisons: Option<Vec<Zaehlzeitsaison>>,
    /// BO4E type discriminant — always `BoTyp::Zaehlzeitdefinition` for this struct.
    #[cfg_attr(feature = "serde", serde(rename = "_typ"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(
        feature = "builder",
        builder(default = Some(BoTyp::Zaehlzeitdefinition), setter(skip))
    )]
    pub typ: Option<BoTyp>,
    /// Der Marktteilnehmer, der diese Zählzeitdefinition herausgegeben hat (typischerweise Netzbetreiber
    /// oder Lieferant). Identifiziert zusammen mit einer fachlichen Gültigkeit, welche Definition zu welchem
    /// Zeitpunkt gilt.
    #[cfg_attr(feature = "serde", serde(rename = "urheber"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    #[cfg_attr(feature = "validate", garde(dive))]
    pub urheber: Option<Box<Marktteilnehmer>>,
    /// Version der BO-Struktur aka "fachliche Versionierung"
    #[cfg_attr(feature = "serde", serde(rename = "_version"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(
        feature = "builder",
        builder(default = Some("202607.1.0".to_owned()), setter(into))
    )]
    pub version: Option<String>,
    #[cfg_attr(feature = "serde", serde(rename = "zusatzAttribute"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "builder", builder(default, setter(into)))]
    #[cfg_attr(feature = "validate", garde(dive))]
    pub zusatz_attribute: Option<Vec<ZusatzAttribut>>,
    /// Unknown JSON fields captured during deserialization for round-trip preservation.
    /// `None` when no unknown fields were present (zero heap allocation).
    #[cfg_attr(feature = "json", serde(flatten))]
    #[cfg_attr(
        feature = "json",
        serde(skip_serializing_if = "crate::json::ext_map_is_empty")
    )]
    #[cfg_attr(not(feature = "json"), serde(skip))]
    #[cfg_attr(feature = "builder", builder(default, setter(skip)))]
    #[doc(hidden)]
    pub _additional: crate::LimitedExtensionMap,
}
impl Default for Zaehlzeitdefinition {
    fn default() -> Self {
        Self {
            feiertagskalender: Default::default(),
            id: Default::default(),
            saisonprofil: Default::default(),
            saisons: Default::default(),
            typ: Some(BoTyp::Zaehlzeitdefinition),
            urheber: Default::default(),
            version: Some("202607.1.0".to_owned()),
            zusatz_attribute: Default::default(),
            _additional: Default::default(),
        }
    }
}
impl Bo4eObject for Zaehlzeitdefinition {
    type BoTyp = BoTyp;
    const BO_TYP: BoTyp = BoTyp::Zaehlzeitdefinition;
    const TYP_WIRE: &'static str = "ZAEHLZEITDEFINITION";
    const SCHEMA_VERSION: &'static str = "202607.1.0";
    const SCHEMA_SERIES: &'static str = "202607";
}
#[cfg(feature = "json")]
impl crate::json::sealed::Sealed for Zaehlzeitdefinition {}
#[cfg(feature = "json")]
impl crate::json::Bo4eJsonExt for Zaehlzeitdefinition {}
#[cfg(feature = "json")]
impl crate::json::Bo4eExtensionData for Zaehlzeitdefinition {
    fn extension_data(&self) -> &indexmap::IndexMap<String, serde_json::Value> {
        self._additional
            .as_map()
            .unwrap_or(&crate::json::extension::EMPTY_EXTENSION_MAP)
    }
    fn has_extension_data(&self) -> bool {
        !self._additional.is_empty()
    }
}
#[cfg(feature = "json")]
impl std::fmt::Display for Zaehlzeitdefinition {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match serde_json::to_string(self) {
            Ok(json) => f.write_str(&json),
            Err(e) => write!(f, "<Zaehlzeitdefinition: serialization error: {e}>"),
        }
    }
}
impl crate::Bo4eStrict for Zaehlzeitdefinition {
    fn collect_unknown_enums(&self, path: &str, out: &mut Vec<String>) {
        if let Some(items) = &self.saisons {
            let child = crate::strict::field_path(path, "saisons");
            for (i, item) in items.iter().enumerate() {
                crate::Bo4eStrict::collect_unknown_enums(
                    item,
                    &crate::strict::index_path(&child, i),
                    out,
                );
            }
        }
        if let Some(v) = &self.urheber {
            crate::Bo4eStrict::collect_unknown_enums(
                &**v,
                &crate::strict::field_path(path, "urheber"),
                out,
            );
        }
        if let Some(items) = &self.zusatz_attribute {
            let child = crate::strict::field_path(path, "zusatzAttribute");
            for (i, item) in items.iter().enumerate() {
                crate::Bo4eStrict::collect_unknown_enums(
                    item,
                    &crate::strict::index_path(&child, i),
                    out,
                );
            }
        }
    }
}