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

//! Balancing (Bilanzierung) business object.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

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

/// Balance group data for energy market balancing.
///
/// German: Bilanzierung
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::Balancing;
/// use bo4e_core::enums::Division;
///
/// let balancing = Balancing {
///     balance_group_id: Some("11XBALANCEGROUP".to_string()),
///     division: Some(Division::Electricity),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Balancing {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Balance group identifier (Bilanzkreis-ID)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub balance_group_id: Option<String>,

    /// Balance group name (Bilanzkreisname)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub balance_group_name: 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>,

    /// Market area (Marktgebiet)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub market_area: Option<String>,

    /// Balance responsible party (Bilanzkreisverantwortlicher)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub balance_responsible_party: Option<Box<super::MarketParticipant>>,

    /// Validity period (Gueltigkeitszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validity_period: Option<TimePeriod>,

    /// Start date of balancing (Startdatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_date: Option<DateTime<Utc>>,

    /// End date of balancing (Enddatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_date: Option<DateTime<Utc>>,
}

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

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

    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_balancing_creation() {
        let balancing = Balancing {
            balance_group_id: Some("11XBALANCEGROUP".to_string()),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        assert_eq!(
            balancing.balance_group_id,
            Some("11XBALANCEGROUP".to_string())
        );
        assert_eq!(balancing.division, Some(Division::Electricity));
    }

    #[test]
    fn test_gas_balancing() {
        let balancing = Balancing {
            balance_group_id: Some("GASBALANCE001".to_string()),
            balance_group_name: Some("Gas Balance Group 1".to_string()),
            division: Some(Division::Gas),
            market_area: Some("NCG".to_string()),
            ..Default::default()
        };

        assert_eq!(balancing.division, Some(Division::Gas));
        assert_eq!(balancing.market_area, Some("NCG".to_string()));
    }

    #[test]
    fn test_serialize() {
        let balancing = Balancing {
            meta: Bo4eMeta::with_type("Bilanzierung"),
            balance_group_id: Some("11XTEST".to_string()),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        let json = serde_json::to_string(&balancing).unwrap();
        assert!(json.contains(r#""balanceGroupId":"11XTEST""#));
    }

    #[test]
    fn test_roundtrip() {
        let balancing = Balancing {
            meta: Bo4eMeta::with_type("Bilanzierung"),
            balance_group_id: Some("11XTEST".to_string()),
            balance_group_name: Some("Test Balance Group".to_string()),
            description: Some("Test description".to_string()),
            division: Some(Division::Electricity),
            market_area: Some("DE".to_string()),
            ..Default::default()
        };

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

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