bo4e_core/com/
seasonal_tariff.rs

1//! Seasonal tariff (Saisontarif) component.
2
3use chrono::NaiveDate;
4use serde::{Deserialize, Serialize};
5
6use crate::traits::{Bo4eMeta, Bo4eObject};
7
8/// A seasonal tariff period with date range and tariff name.
9///
10/// German: Saisontarif
11///
12/// # Example
13///
14/// ```rust
15/// use bo4e_core::com::SeasonalTariff;
16/// use chrono::NaiveDate;
17///
18/// let tariff = SeasonalTariff {
19///     season_name: Some("Winter".to_string()),
20///     start_date: Some(NaiveDate::from_ymd_opt(2024, 11, 1).unwrap()),
21///     end_date: Some(NaiveDate::from_ymd_opt(2025, 3, 31).unwrap()),
22///     ..Default::default()
23/// };
24/// ```
25#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
26#[serde(rename_all = "camelCase")]
27pub struct SeasonalTariff {
28    /// BO4E metadata
29    #[serde(flatten)]
30    pub meta: Bo4eMeta,
31
32    /// Name of the season/tariff period (Saisonbezeichnung)
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub season_name: Option<String>,
35
36    /// Start date of the season (Startdatum)
37    #[serde(skip_serializing_if = "Option::is_none")]
38    pub start_date: Option<NaiveDate>,
39
40    /// End date of the season (Enddatum)
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub end_date: Option<NaiveDate>,
43
44    /// Tariff identifier (Tarifkennung)
45    #[serde(skip_serializing_if = "Option::is_none")]
46    pub tariff_id: Option<String>,
47
48    /// Price factor for the season (Preisfaktor)
49    #[serde(skip_serializing_if = "Option::is_none")]
50    pub price_factor: Option<f64>,
51}
52
53impl Bo4eObject for SeasonalTariff {
54    fn type_name_german() -> &'static str {
55        "Saisontarif"
56    }
57
58    fn type_name_english() -> &'static str {
59        "SeasonalTariff"
60    }
61
62    fn meta(&self) -> &Bo4eMeta {
63        &self.meta
64    }
65
66    fn meta_mut(&mut self) -> &mut Bo4eMeta {
67        &mut self.meta
68    }
69}
70
71#[cfg(test)]
72mod tests {
73    use super::*;
74
75    #[test]
76    fn test_winter_tariff() {
77        let tariff = SeasonalTariff {
78            season_name: Some("Winter".to_string()),
79            start_date: Some(NaiveDate::from_ymd_opt(2024, 11, 1).unwrap()),
80            end_date: Some(NaiveDate::from_ymd_opt(2025, 3, 31).unwrap()),
81            price_factor: Some(1.2),
82            ..Default::default()
83        };
84
85        let json = serde_json::to_string(&tariff).unwrap();
86        assert!(json.contains("Winter"));
87        assert!(json.contains("1.2"));
88    }
89
90    #[test]
91    fn test_roundtrip() {
92        let tariff = SeasonalTariff {
93            season_name: Some("Summer".to_string()),
94            tariff_id: Some("SUMMER_2024".to_string()),
95            ..Default::default()
96        };
97
98        let json = serde_json::to_string(&tariff).unwrap();
99        let parsed: SeasonalTariff = serde_json::from_str(&json).unwrap();
100        assert_eq!(tariff, parsed);
101    }
102
103    #[test]
104    fn test_bo4e_object_impl() {
105        assert_eq!(SeasonalTariff::type_name_german(), "Saisontarif");
106        assert_eq!(SeasonalTariff::type_name_english(), "SeasonalTariff");
107    }
108}