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

//! Tariff price (Tarifpreis) component.

use serde::{Deserialize, Serialize};

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

/// A tariff price with its type and value.
///
/// German: Tarifpreis
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::TariffPrice;
/// use bo4e_core::enums::{Currency, PriceType, Unit};
///
/// let tariff_price = TariffPrice {
///     price_type: Some(PriceType::WorkingPriceSingleTariff),
///     value: Some(0.30),
///     currency: Some(Currency::Eur),
///     reference_unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TariffPrice {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

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

    /// Price value (Wert)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<f64>,

    /// Currency (Waehrung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,

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

    /// Description (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

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

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

    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_work_price() {
        let price = TariffPrice {
            price_type: Some(PriceType::WorkingPriceSingleTariff),
            value: Some(30.5),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::KilowattHour),
            ..Default::default()
        };

        assert_eq!(price.price_type, Some(PriceType::WorkingPriceSingleTariff));
        assert_eq!(price.value, Some(30.5));
    }

    #[test]
    fn test_base_price() {
        let price = TariffPrice {
            price_type: Some(PriceType::BasePrice),
            value: Some(12.50),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::Month),
            description: Some("Monthly base fee".to_string()),
            ..Default::default()
        };

        assert_eq!(price.price_type, Some(PriceType::BasePrice));
    }

    #[test]
    fn test_default() {
        let price = TariffPrice::default();
        assert!(price.price_type.is_none());
        assert!(price.value.is_none());
    }

    #[test]
    fn test_roundtrip() {
        let price = TariffPrice {
            price_type: Some(PriceType::WorkingPriceSingleTariff),
            value: Some(25.75),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::KilowattHour),
            description: Some("Peak rate".to_string()),
            ..Default::default()
        };

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

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