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
140
141

//! Price (Preis) component.

use serde::{Deserialize, Serialize};

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

/// A price with value, currency, and unit.
///
/// German: Preis
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::Price;
/// use bo4e_core::enums::{Currency, Unit};
///
/// let price = Price {
///     value: Some(0.25),
///     currency: Some(Currency::Eur),
///     reference_unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Price {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// 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>,

    /// Unit that the price applies to (Bezugswert)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reference_unit: Option<Unit>,

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

    /// Status of the price (Preisstatus)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<PriceStatus>,
}

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

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

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

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

impl Price {
    /// Create a price in EUR per kWh.
    pub fn eur_per_kwh(value: f64) -> Self {
        Self {
            value: Some(value),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::KilowattHour),
            ..Default::default()
        }
    }

    /// Create a price in EUR per month (base price).
    pub fn eur_per_month(value: f64) -> Self {
        Self {
            value: Some(value),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::Month),
            price_type: Some(PriceType::BasePrice),
            ..Default::default()
        }
    }
}

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

    #[test]
    fn test_energy_price() {
        let price = Price::eur_per_kwh(0.30);
        assert_eq!(price.value, Some(0.30));
        assert_eq!(price.currency, Some(Currency::Eur));
        assert_eq!(price.reference_unit, Some(Unit::KilowattHour));
    }

    #[test]
    fn test_base_price() {
        let price = Price::eur_per_month(12.50);
        assert_eq!(price.value, Some(12.50));
        assert_eq!(price.currency, Some(Currency::Eur));
        assert_eq!(price.reference_unit, Some(Unit::Month));
        assert_eq!(price.price_type, Some(PriceType::BasePrice));
    }

    #[test]
    fn test_serialize() {
        let price = Price {
            value: Some(12.50),
            currency: Some(Currency::Eur),
            ..Default::default()
        };

        let json = serde_json::to_string(&price).unwrap();
        assert!(json.contains(r#""value":12.5"#));
        assert!(json.contains(r#""currency":"EUR""#));
    }

    #[test]
    fn test_roundtrip() {
        let price = Price::eur_per_kwh(0.2567);
        let json = serde_json::to_string(&price).unwrap();
        let parsed: Price = serde_json::from_str(&json).unwrap();
        assert_eq!(price, parsed);
    }

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