bo4e-core 0.2.0

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
114

//! Regional price tier (RegionalePreisstaffel) component.

use serde::{Deserialize, Serialize};

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

use super::PriceTier;

/// A price tier that applies to a specific region.
///
/// German: RegionalePreisstaffel
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::{RegionalPriceTier, PriceTier};
///
/// let regional_tier = RegionalPriceTier {
///     region_code: Some("50667".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "RegionalePreisstaffel"))]
#[serde(rename_all = "camelCase")]
pub struct RegionalPriceTier {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Region code (postal code, network area, etc.) (Regionscode)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "regionscode"))]
    pub region_code: Option<String>,

    /// Price tiers for this region (Preisstaffeln)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "preisstaffeln"))]
    pub tiers: Vec<PriceTier>,
}

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

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

    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_regional_tier() {
        let tier = RegionalPriceTier {
            region_code: Some("50667".to_string()),
            tiers: vec![PriceTier {
                lower_limit: Some(0.0),
                upper_limit: Some(1000.0),
                unit_price: Some(0.28),
                ..Default::default()
            }],
            ..Default::default()
        };

        assert_eq!(tier.region_code, Some("50667".to_string()));
        assert_eq!(tier.tiers.len(), 1);
    }

    #[test]
    fn test_default() {
        let tier = RegionalPriceTier::default();
        assert!(tier.region_code.is_none());
        assert!(tier.tiers.is_empty());
    }

    #[test]
    fn test_roundtrip() {
        let tier = RegionalPriceTier {
            region_code: Some("NRW-001".to_string()),
            tiers: vec![PriceTier {
                unit_price: Some(0.30),
                tier_number: Some(1),
                ..Default::default()
            }],
            ..Default::default()
        };

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

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