bo4e-core 0.1.1

Core types for BO4E (Business Objects for Energy)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Regional surcharge (AufAbschlagRegional) component.

use serde::{Deserialize, Serialize};

use crate::enums::TariffRegionCriterion;
use crate::traits::{Bo4eMeta, Bo4eObject};

use super::Surcharge;

/// A surcharge that applies to a specific regional criterion.
///
/// German: AufAbschlagRegional
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::RegionalSurcharge;
/// use bo4e_core::enums::TariffRegionCriterion;
///
/// let surcharge = RegionalSurcharge {
///     region_criterion: Some(TariffRegionCriterion::PostalCode),
///     region_code: Some("50*".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RegionalSurcharge {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Type of regional criterion (Tarifregionskriterium)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region_criterion: Option<TariffRegionCriterion>,

    /// Region code/value (Regionscode)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region_code: Option<String>,

    /// Surcharges applicable to this region (AufAbschläge)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub surcharges: Vec<Surcharge>,
}

impl Bo4eObject for RegionalSurcharge {
    fn type_name_german() -> &'static str {
        "AufAbschlagRegional"
    }

    fn type_name_english() -> &'static str {
        "RegionalSurcharge"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_postal_region_surcharge() {
        let surcharge = RegionalSurcharge {
            region_criterion: Some(TariffRegionCriterion::PostalCode),
            region_code: Some("50*".to_string()),
            surcharges: vec![Surcharge {
                description: Some("Regional discount".to_string()),
                value: Some(-5.0),
                ..Default::default()
            }],
            ..Default::default()
        };

        assert_eq!(
            surcharge.region_criterion,
            Some(TariffRegionCriterion::PostalCode)
        );
        assert_eq!(surcharge.surcharges.len(), 1);
    }

    #[test]
    fn test_default() {
        let surcharge = RegionalSurcharge::default();
        assert!(surcharge.region_criterion.is_none());
        assert!(surcharge.surcharges.is_empty());
    }

    #[test]
    fn test_roundtrip() {
        let surcharge = RegionalSurcharge {
            region_criterion: Some(TariffRegionCriterion::NetworkNumber),
            region_code: Some("9990001".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&surcharge).unwrap();
        let parsed: RegionalSurcharge = serde_json::from_str(&json).unwrap();
        assert_eq!(surcharge, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(RegionalSurcharge::type_name_german(), "AufAbschlagRegional");
        assert_eq!(RegionalSurcharge::type_name_english(), "RegionalSurcharge");
    }
}