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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Tariff price position (Tarifpreisposition) component.

use serde::{Deserialize, Serialize};

use crate::enums::{CalculationMethod, PriceType, Unit};
use crate::traits::{Bo4eMeta, Bo4eObject};

use super::TariffPrice;

/// A tariff price position with its associated tariff prices.
///
/// German: Tarifpreisposition
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::{TariffPricePosition, TariffPrice};
/// use bo4e_core::enums::PriceType;
///
/// let position = TariffPricePosition {
///     description: Some("Arbeitspreis".to_string()),
///     price_type: Some(PriceType::WorkingPriceSingleTariff),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TariffPricePosition {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Description of the position (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Type of price (Preistyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price_type: Option<PriceType>,

    /// Reference unit (Bezugseinheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_unit: Option<Unit>,

    /// Calculation method (Berechnungsmethode)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub calculation_method: Option<CalculationMethod>,

    /// Tariff prices (Tarifpreise)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub prices: Vec<TariffPrice>,

    /// Article ID (Artikel-ID)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub article_id: Option<String>,
}

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

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

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

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

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

    #[test]
    fn test_tariff_price_position() {
        let position = TariffPricePosition {
            description: Some("Arbeitspreis HT/NT".to_string()),
            price_type: Some(PriceType::WorkingPriceSingleTariff),
            reference_unit: Some(Unit::KilowattHour),
            prices: vec![
                TariffPrice {
                    description: Some("HT".to_string()),
                    value: Some(30.5),
                    currency: Some(Currency::Eur),
                    ..Default::default()
                },
                TariffPrice {
                    description: Some("NT".to_string()),
                    value: Some(22.0),
                    currency: Some(Currency::Eur),
                    ..Default::default()
                },
            ],
            ..Default::default()
        };

        assert_eq!(position.prices.len(), 2);
    }

    #[test]
    fn test_default() {
        let position = TariffPricePosition::default();
        assert!(position.description.is_none());
        assert!(position.prices.is_empty());
    }

    #[test]
    fn test_roundtrip() {
        let position = TariffPricePosition {
            description: Some("Grundpreis".to_string()),
            price_type: Some(PriceType::BasePrice),
            article_id: Some("GP-001".to_string()),
            ..Default::default()
        };

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

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