bo4e_core/com/
energy_source.rs

1//! Energy source (Energieherkunft) component.
2
3use serde::{Deserialize, Serialize};
4
5use crate::enums::GenerationType;
6use crate::traits::{Bo4eMeta, Bo4eObject};
7
8/// An energy source with its generation type and percentage share.
9///
10/// German: Energieherkunft
11///
12/// # Example
13///
14/// ```rust
15/// use bo4e_core::com::EnergySource;
16/// use bo4e_core::enums::GenerationType;
17///
18/// let source = EnergySource {
19///     generation_type: Some(GenerationType::Solar),
20///     percentage_share: Some(35.0),
21///     ..Default::default()
22/// };
23/// ```
24#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
25#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
26#[cfg_attr(feature = "json-schema", schemars(rename = "Energieherkunft"))]
27#[serde(rename_all = "camelCase")]
28pub struct EnergySource {
29    /// BO4E metadata
30    #[serde(flatten)]
31    pub meta: Bo4eMeta,
32
33    /// Type of energy generation (Erzeugungsart)
34    #[serde(skip_serializing_if = "Option::is_none")]
35    #[cfg_attr(feature = "json-schema", schemars(rename = "erzeugungsart"))]
36    pub generation_type: Option<GenerationType>,
37
38    /// Percentage share of this generation type (Anteil in Prozent)
39    #[serde(skip_serializing_if = "Option::is_none")]
40    #[cfg_attr(feature = "json-schema", schemars(rename = "anteilProzent"))]
41    pub percentage_share: Option<f64>,
42}
43
44impl Bo4eObject for EnergySource {
45    fn type_name_german() -> &'static str {
46        "Energieherkunft"
47    }
48
49    fn type_name_english() -> &'static str {
50        "EnergySource"
51    }
52
53    fn meta(&self) -> &Bo4eMeta {
54        &self.meta
55    }
56
57    fn meta_mut(&mut self) -> &mut Bo4eMeta {
58        &mut self.meta
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65
66    #[test]
67    fn test_solar_source() {
68        let source = EnergySource {
69            generation_type: Some(GenerationType::Solar),
70            percentage_share: Some(35.0),
71            ..Default::default()
72        };
73
74        assert_eq!(source.generation_type, Some(GenerationType::Solar));
75        assert_eq!(source.percentage_share, Some(35.0));
76    }
77
78    #[test]
79    fn test_wind_source() {
80        let source = EnergySource {
81            generation_type: Some(GenerationType::Wind),
82            percentage_share: Some(45.0),
83            ..Default::default()
84        };
85
86        assert_eq!(source.generation_type, Some(GenerationType::Wind));
87    }
88
89    #[test]
90    fn test_default() {
91        let source = EnergySource::default();
92        assert!(source.generation_type.is_none());
93        assert!(source.percentage_share.is_none());
94    }
95
96    #[test]
97    fn test_serialize() {
98        let source = EnergySource {
99            generation_type: Some(GenerationType::Solar),
100            percentage_share: Some(25.5),
101            ..Default::default()
102        };
103
104        let json = serde_json::to_string(&source).unwrap();
105        assert!(json.contains(r#""generationType":"SOLAR""#));
106        assert!(json.contains(r#""percentageShare":25.5"#));
107    }
108
109    #[test]
110    fn test_roundtrip() {
111        let source = EnergySource {
112            generation_type: Some(GenerationType::Wind),
113            percentage_share: Some(60.0),
114            ..Default::default()
115        };
116
117        let json = serde_json::to_string(&source).unwrap();
118        let parsed: EnergySource = serde_json::from_str(&json).unwrap();
119        assert_eq!(source, parsed);
120    }
121
122    #[test]
123    fn test_bo4e_object_impl() {
124        assert_eq!(EnergySource::type_name_german(), "Energieherkunft");
125        assert_eq!(EnergySource::type_name_english(), "EnergySource");
126    }
127}
bo4e_core/com/energy_source.rs

bo4e_core/com/
energy_source.rs
