bo4e_core/bo/
regional_tariff.rs

1//! Regional tariff (Regionaltarif) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{RegionalPriceTier, RegionalSurcharge, TimePeriod};
7use crate::enums::Division;
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A regional tariff definition.
11///
12/// German: Regionaltarif
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::RegionalTariff;
18/// use bo4e_core::enums::Division;
19///
20/// let tariff = RegionalTariff {
21///     tariff_code: Some("RT-2024-001".to_string()),
22///     name: Some("Regional Standard Tariff".to_string()),
23///     division: Some(Division::Electricity),
24///     ..Default::default()
25/// };
26/// ```
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28#[serde(rename_all = "camelCase")]
29pub struct RegionalTariff {
30    /// BO4E metadata
31    #[serde(flatten)]
32    pub meta: Bo4eMeta,
33
34    /// Tariff code (Tarifcode)
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub tariff_code: Option<String>,
37
38    /// Tariff name (Tarifname)
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub name: Option<String>,
41
42    /// Description (Beschreibung)
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub description: Option<String>,
45
46    /// Energy division (Sparte)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub division: Option<Division>,
49
50    /// Tariff provider (Tarifanbieter)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub provider: Option<Box<super::BusinessPartner>>,
53
54    /// Region this tariff applies to (Region)
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub region: Option<Box<super::Region>>,
57
58    /// Validity period (Gueltigkeitszeitraum)
59    #[serde(skip_serializing_if = "Option::is_none")]
60    pub validity_period: Option<TimePeriod>,
61
62    /// Start date (Startdatum)
63    #[serde(skip_serializing_if = "Option::is_none")]
64    pub start_date: Option<DateTime<Utc>>,
65
66    /// End date (Enddatum)
67    #[serde(skip_serializing_if = "Option::is_none")]
68    pub end_date: Option<DateTime<Utc>>,
69
70    /// Regional price tiers (Regionale Preisstufen)
71    #[serde(default, skip_serializing_if = "Vec::is_empty")]
72    pub price_tiers: Vec<RegionalPriceTier>,
73
74    /// Regional surcharges (Regionale Aufschlaege)
75    #[serde(default, skip_serializing_if = "Vec::is_empty")]
76    pub surcharges: Vec<RegionalSurcharge>,
77}
78
79impl Bo4eObject for RegionalTariff {
80    fn type_name_german() -> &'static str {
81        "Regionaltarif"
82    }
83
84    fn type_name_english() -> &'static str {
85        "RegionalTariff"
86    }
87
88    fn meta(&self) -> &Bo4eMeta {
89        &self.meta
90    }
91
92    fn meta_mut(&mut self) -> &mut Bo4eMeta {
93        &mut self.meta
94    }
95}
96
97#[cfg(test)]
98mod tests {
99    use super::*;
100
101    #[test]
102    fn test_regional_tariff_creation() {
103        let tariff = RegionalTariff {
104            tariff_code: Some("RT-2024-001".to_string()),
105            name: Some("Regional Standard Tariff".to_string()),
106            division: Some(Division::Electricity),
107            ..Default::default()
108        };
109
110        assert_eq!(tariff.tariff_code, Some("RT-2024-001".to_string()));
111        assert_eq!(tariff.division, Some(Division::Electricity));
112    }
113
114    #[test]
115    fn test_tariff_with_region() {
116        use crate::bo::Region;
117        use crate::enums::RegionType;
118
119        let region = Box::new(Region {
120            region_code: Some("DE-BY".to_string()),
121            name: Some("Bavaria".to_string()),
122            region_type: Some(RegionType::SupplyArea),
123            ..Default::default()
124        });
125
126        let tariff = RegionalTariff {
127            tariff_code: Some("RT-BY-001".to_string()),
128            name: Some("Bavaria Regional Tariff".to_string()),
129            region: Some(region),
130            ..Default::default()
131        };
132
133        assert!(tariff.region.is_some());
134    }
135
136    #[test]
137    fn test_serialize() {
138        let tariff = RegionalTariff {
139            meta: Bo4eMeta::with_type("Regionaltarif"),
140            tariff_code: Some("RT-001".to_string()),
141            name: Some("Test Tariff".to_string()),
142            ..Default::default()
143        };
144
145        let json = serde_json::to_string(&tariff).unwrap();
146        assert!(json.contains(r#""tariffCode":"RT-001""#));
147        assert!(json.contains(r#""name":"Test Tariff""#));
148    }
149
150    #[test]
151    fn test_roundtrip() {
152        let tariff = RegionalTariff {
153            meta: Bo4eMeta::with_type("Regionaltarif"),
154            tariff_code: Some("RT-001".to_string()),
155            name: Some("Test Tariff".to_string()),
156            description: Some("A test regional tariff".to_string()),
157            division: Some(Division::Electricity),
158            ..Default::default()
159        };
160
161        let json = serde_json::to_string(&tariff).unwrap();
162        let parsed: RegionalTariff = serde_json::from_str(&json).unwrap();
163        assert_eq!(tariff, parsed);
164    }
165
166    #[test]
167    fn test_bo4e_object_impl() {
168        assert_eq!(RegionalTariff::type_name_german(), "Regionaltarif");
169        assert_eq!(RegionalTariff::type_name_english(), "RegionalTariff");
170    }
171}
bo4e_core/bo/regional_tariff.rs

bo4e_core/bo/
regional_tariff.rs
