bo4e_core/bo/
region.rs

1//! Region (Region) business object.
2
3use serde::{Deserialize, Serialize};
4
5use crate::com::RegionCriterion;
6use crate::enums::RegionType;
7use crate::traits::{Bo4eMeta, Bo4eObject};
8
9/// A geographical region in the energy market.
10///
11/// German: Region
12///
13/// # Example
14///
15/// ```rust
16/// use bo4e_core::bo::Region;
17/// use bo4e_core::enums::RegionType;
18///
19/// let region = Region {
20///     region_code: Some("DE-BY".to_string()),
21///     name: Some("Bavaria".to_string()),
22///     region_type: Some(RegionType::SupplyArea),
23///     ..Default::default()
24/// };
25/// ```
26#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
27#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
28#[cfg_attr(feature = "json-schema", schemars(rename = "Region"))]
29#[serde(rename_all = "camelCase")]
30pub struct Region {
31    /// BO4E metadata
32    #[serde(flatten)]
33    pub meta: Bo4eMeta,
34
35    /// Region code (Regionscode)
36    #[serde(skip_serializing_if = "Option::is_none")]
37    #[cfg_attr(feature = "json-schema", schemars(rename = "regionscode"))]
38    pub region_code: Option<String>,
39
40    /// Region name (Name)
41    #[serde(skip_serializing_if = "Option::is_none")]
42    #[cfg_attr(feature = "json-schema", schemars(rename = "name"))]
43    pub name: Option<String>,
44
45    /// Description (Beschreibung)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
48    pub description: Option<String>,
49
50    /// Type of region (Gebietstyp)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    #[cfg_attr(feature = "json-schema", schemars(rename = "gebietstyp"))]
53    pub region_type: Option<RegionType>,
54
55    /// Criteria that define this region (Regionskriterien)
56    #[serde(default, skip_serializing_if = "Vec::is_empty")]
57    #[cfg_attr(feature = "json-schema", schemars(rename = "regionskriterien"))]
58    pub criteria: Vec<RegionCriterion>,
59
60    /// Parent region (Uebergeordnete Region)
61    #[serde(skip_serializing_if = "Option::is_none")]
62    #[cfg_attr(feature = "json-schema", schemars(rename = "uebergeordneteRegion"))]
63    pub parent_region: Option<Box<Region>>,
64
65    /// Sub-regions (Unterregionen)
66    #[serde(default, skip_serializing_if = "Vec::is_empty")]
67    #[cfg_attr(feature = "json-schema", schemars(rename = "unterregionen"))]
68    pub sub_regions: Vec<Box<Region>>,
69}
70
71impl Bo4eObject for Region {
72    fn type_name_german() -> &'static str {
73        "Region"
74    }
75
76    fn type_name_english() -> &'static str {
77        "Region"
78    }
79
80    fn meta(&self) -> &Bo4eMeta {
81        &self.meta
82    }
83
84    fn meta_mut(&mut self) -> &mut Bo4eMeta {
85        &mut self.meta
86    }
87}
88
89#[cfg(test)]
90mod tests {
91    use super::*;
92
93    #[test]
94    fn test_region_creation() {
95        let region = Region {
96            region_code: Some("DE-BY".to_string()),
97            name: Some("Bavaria".to_string()),
98            region_type: Some(RegionType::SupplyArea),
99            ..Default::default()
100        };
101
102        assert_eq!(region.region_code, Some("DE-BY".to_string()));
103        assert_eq!(region.region_type, Some(RegionType::SupplyArea));
104    }
105
106    #[test]
107    fn test_market_area_region() {
108        let region = Region {
109            region_code: Some("TRADING-HUB-EUROPE".to_string()),
110            name: Some("Trading Hub Europe".to_string()),
111            region_type: Some(RegionType::MarketArea),
112            ..Default::default()
113        };
114
115        assert_eq!(region.region_type, Some(RegionType::MarketArea));
116    }
117
118    #[test]
119    fn test_nested_regions() {
120        let sub_region = Box::new(Region {
121            region_code: Some("DE-BY-M".to_string()),
122            name: Some("Munich Area".to_string()),
123            ..Default::default()
124        });
125
126        let region = Region {
127            region_code: Some("DE-BY".to_string()),
128            name: Some("Bavaria".to_string()),
129            sub_regions: vec![sub_region],
130            ..Default::default()
131        };
132
133        assert_eq!(region.sub_regions.len(), 1);
134        assert_eq!(region.sub_regions[0].name, Some("Munich Area".to_string()));
135    }
136
137    #[test]
138    fn test_serialize() {
139        let region = Region {
140            meta: Bo4eMeta::with_type("Region"),
141            region_code: Some("DE-BY".to_string()),
142            name: Some("Bavaria".to_string()),
143            ..Default::default()
144        };
145
146        let json = serde_json::to_string(&region).unwrap();
147        assert!(json.contains(r#""regionCode":"DE-BY""#));
148        assert!(json.contains(r#""name":"Bavaria""#));
149    }
150
151    #[test]
152    fn test_roundtrip() {
153        let region = Region {
154            meta: Bo4eMeta::with_type("Region"),
155            region_code: Some("DE-BY".to_string()),
156            name: Some("Bavaria".to_string()),
157            description: Some("State of Bavaria".to_string()),
158            region_type: Some(RegionType::SupplyArea),
159            ..Default::default()
160        };
161
162        let json = serde_json::to_string(&region).unwrap();
163        let parsed: Region = serde_json::from_str(&json).unwrap();
164        assert_eq!(region, parsed);
165    }
166
167    #[test]
168    fn test_bo4e_object_impl() {
169        assert_eq!(Region::type_name_german(), "Region");
170        assert_eq!(Region::type_name_english(), "Region");
171    }
172}
bo4e_core/bo/region.rs

bo4e_core/bo/
region.rs
