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

//! Network charge (Netzentgelt) component.

use serde::{Deserialize, Serialize};

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

/// A network charge/fee component.
///
/// German: Netzentgelt
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::NetworkCharge;
/// use bo4e_core::enums::PriceType;
///
/// let charge = NetworkCharge {
///     price_type: Some(PriceType::WorkingPriceSingleTariff),
///     value: Some(5.82),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NetworkCharge {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

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

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

    /// Network operator code (Netzbetreiber)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub network_operator_code: Option<String>,
}

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

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

    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_charge() {
        let charge = NetworkCharge {
            price_type: Some(PriceType::WorkingPriceSingleTariff),
            value: Some(5.82),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::KilowattHour),
            ..Default::default()
        };

        assert_eq!(charge.price_type, Some(PriceType::WorkingPriceSingleTariff));
        assert_eq!(charge.value, Some(5.82));
    }

    #[test]
    fn test_base_price_charge() {
        let charge = NetworkCharge {
            price_type: Some(PriceType::BasePrice),
            value: Some(55.0),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::Year),
            network_operator_code: Some("9900001".to_string()),
            ..Default::default()
        };

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

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

    #[test]
    fn test_roundtrip() {
        let charge = NetworkCharge {
            price_type: Some(PriceType::WorkingPriceSingleTariff),
            value: Some(6.25),
            currency: Some(Currency::Eur),
            reference_unit: Some(Unit::KilowattHour),
            description: Some("Arbeitspreis Netznutzung".to_string()),
            ..Default::default()
        };

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

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