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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Costs (Kosten) business object.

use serde::{Deserialize, Serialize};

use crate::com::{Amount, CostBlock, TimePeriod};
use crate::enums::Division;
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A cost breakdown/summary.
///
/// German: Kosten
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::Costs;
/// use bo4e_core::com::Amount;
/// use bo4e_core::enums::Division;
///
/// let costs = Costs {
///     designation: Some("Jahreskosten 2024".to_string()),
///     division: Some(Division::Electricity),
///     total_amount: Some(Amount::eur(2500.00)),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Costs {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Name/designation of the cost summary (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub designation: Option<String>,

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

    /// Energy division (Sparte)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub division: Option<Division>,

    /// Period the costs apply to (Abrechnungszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period: Option<TimePeriod>,

    /// Total amount (Gesamtbetrag)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_amount: Option<Amount>,

    /// Cost blocks (Kostenbloecke)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub cost_blocks: Vec<CostBlock>,

    /// Related market location (Marktlokation)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub market_location: Option<Box<super::MarketLocation>>,
}

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

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

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

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

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

    #[test]
    fn test_costs_creation() {
        let costs = Costs {
            designation: Some("Jahreskosten 2024".to_string()),
            division: Some(Division::Electricity),
            total_amount: Some(Amount::eur(2500.00)),
            ..Default::default()
        };

        assert_eq!(costs.total_amount, Some(Amount::eur(2500.00)));
    }

    #[test]
    fn test_costs_with_blocks() {
        let costs = Costs {
            designation: Some("Annual Costs".to_string()),
            cost_blocks: vec![
                CostBlock {
                    designation: Some("Energy".to_string()),
                    total_amount: Some(Amount::eur(1500.0)),
                    ..Default::default()
                },
                CostBlock {
                    designation: Some("Network".to_string()),
                    total_amount: Some(Amount::eur(800.0)),
                    ..Default::default()
                },
            ],
            total_amount: Some(Amount::eur(2300.0)),
            ..Default::default()
        };

        assert_eq!(costs.cost_blocks.len(), 2);
    }

    #[test]
    fn test_serialize() {
        let costs = Costs {
            meta: Bo4eMeta::with_type("Kosten"),
            designation: Some("Test Costs".to_string()),
            total_amount: Some(Amount::eur(1000.0)),
            ..Default::default()
        };

        let json = serde_json::to_string(&costs).unwrap();
        assert!(json.contains(r#""designation":"Test Costs""#));
        assert!(json.contains(r#""_typ":"Kosten""#));
    }

    #[test]
    fn test_roundtrip() {
        let costs = Costs {
            meta: Bo4eMeta::with_type("Kosten"),
            designation: Some("Gas Costs".to_string()),
            description: Some("Annual gas costs".to_string()),
            division: Some(Division::Gas),
            total_amount: Some(Amount::eur(1234.56)),
            ..Default::default()
        };

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

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