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#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
29#[cfg_attr(feature = "json-schema", schemars(rename = "Regionaltarif"))]
30#[serde(rename_all = "camelCase")]
31pub struct RegionalTariff {
32    /// BO4E metadata
33    #[serde(flatten)]
34    pub meta: Bo4eMeta,
35
36    /// Tariff code (Tarifcode)
37    #[serde(skip_serializing_if = "Option::is_none")]
38    #[cfg_attr(feature = "json-schema", schemars(rename = "tarifcode"))]
39    pub tariff_code: Option<String>,
40
41    /// Tariff name (Tarifname)
42    #[serde(skip_serializing_if = "Option::is_none")]
43    #[cfg_attr(feature = "json-schema", schemars(rename = "tarifname"))]
44    pub name: Option<String>,
45
46    /// Description (Beschreibung)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
49    pub description: Option<String>,
50
51    /// Energy division (Sparte)
52    #[serde(skip_serializing_if = "Option::is_none")]
53    #[cfg_attr(feature = "json-schema", schemars(rename = "sparte"))]
54    pub division: Option<Division>,
55
56    /// Tariff provider (Tarifanbieter)
57    #[serde(skip_serializing_if = "Option::is_none")]
58    #[cfg_attr(feature = "json-schema", schemars(rename = "tarifanbieter"))]
59    pub provider: Option<Box<super::BusinessPartner>>,
60
61    /// Region this tariff applies to (Region)
62    #[serde(skip_serializing_if = "Option::is_none")]
63    #[cfg_attr(feature = "json-schema", schemars(rename = "region"))]
64    pub region: Option<Box<super::Region>>,
65
66    /// Validity period (Gueltigkeitszeitraum)
67    #[serde(skip_serializing_if = "Option::is_none")]
68    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigkeitszeitraum"))]
69    pub validity_period: Option<TimePeriod>,
70
71    /// Start date (Startdatum)
72    #[serde(skip_serializing_if = "Option::is_none")]
73    #[cfg_attr(feature = "json-schema", schemars(rename = "startdatum"))]
74    pub start_date: Option<DateTime<Utc>>,
75
76    /// End date (Enddatum)
77    #[serde(skip_serializing_if = "Option::is_none")]
78    #[cfg_attr(feature = "json-schema", schemars(rename = "enddatum"))]
79    pub end_date: Option<DateTime<Utc>>,
80
81    /// Regional price tiers (Regionale Preisstufen)
82    #[serde(default, skip_serializing_if = "Vec::is_empty")]
83    #[cfg_attr(feature = "json-schema", schemars(rename = "regionalePreisstufen"))]
84    pub price_tiers: Vec<RegionalPriceTier>,
85
86    /// Regional surcharges (Regionale Aufschlaege)
87    #[serde(default, skip_serializing_if = "Vec::is_empty")]
88    #[cfg_attr(feature = "json-schema", schemars(rename = "regionaleAufschlaege"))]
89    pub surcharges: Vec<RegionalSurcharge>,
90}
91
92impl Bo4eObject for RegionalTariff {
93    fn type_name_german() -> &'static str {
94        "Regionaltarif"
95    }
96
97    fn type_name_english() -> &'static str {
98        "RegionalTariff"
99    }
100
101    fn meta(&self) -> &Bo4eMeta {
102        &self.meta
103    }
104
105    fn meta_mut(&mut self) -> &mut Bo4eMeta {
106        &mut self.meta
107    }
108}
109
110#[cfg(test)]
111mod tests {
112    use super::*;
113
114    #[test]
115    fn test_regional_tariff_creation() {
116        let tariff = RegionalTariff {
117            tariff_code: Some("RT-2024-001".to_string()),
118            name: Some("Regional Standard Tariff".to_string()),
119            division: Some(Division::Electricity),
120            ..Default::default()
121        };
122
123        assert_eq!(tariff.tariff_code, Some("RT-2024-001".to_string()));
124        assert_eq!(tariff.division, Some(Division::Electricity));
125    }
126
127    #[test]
128    fn test_tariff_with_region() {
129        use crate::bo::Region;
130        use crate::enums::RegionType;
131
132        let region = Box::new(Region {
133            region_code: Some("DE-BY".to_string()),
134            name: Some("Bavaria".to_string()),
135            region_type: Some(RegionType::SupplyArea),
136            ..Default::default()
137        });
138
139        let tariff = RegionalTariff {
140            tariff_code: Some("RT-BY-001".to_string()),
141            name: Some("Bavaria Regional Tariff".to_string()),
142            region: Some(region),
143            ..Default::default()
144        };
145
146        assert!(tariff.region.is_some());
147    }
148
149    #[test]
150    fn test_serialize() {
151        let tariff = RegionalTariff {
152            meta: Bo4eMeta::with_type("Regionaltarif"),
153            tariff_code: Some("RT-001".to_string()),
154            name: Some("Test Tariff".to_string()),
155            ..Default::default()
156        };
157
158        let json = serde_json::to_string(&tariff).unwrap();
159        assert!(json.contains(r#""tariffCode":"RT-001""#));
160        assert!(json.contains(r#""name":"Test Tariff""#));
161    }
162
163    #[test]
164    fn test_roundtrip() {
165        let tariff = RegionalTariff {
166            meta: Bo4eMeta::with_type("Regionaltarif"),
167            tariff_code: Some("RT-001".to_string()),
168            name: Some("Test Tariff".to_string()),
169            description: Some("A test regional tariff".to_string()),
170            division: Some(Division::Electricity),
171            ..Default::default()
172        };
173
174        let json = serde_json::to_string(&tariff).unwrap();
175        let parsed: RegionalTariff = serde_json::from_str(&json).unwrap();
176        assert_eq!(tariff, parsed);
177    }
178
179    #[test]
180    fn test_bo4e_object_impl() {
181        assert_eq!(RegionalTariff::type_name_german(), "Regionaltarif");
182        assert_eq!(RegionalTariff::type_name_english(), "RegionalTariff");
183    }
184}
bo4e_core/bo/regional_tariff.rs

bo4e_core/bo/
regional_tariff.rs
