bo4e-core 0.2.0

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

//! Billing period data (Abrechnungsperiodendaten) component.

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

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

/// Data for a billing period.
///
/// German: Abrechnungsperiodendaten
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::BillingPeriodData;
/// use bo4e_core::enums::Unit;
/// use chrono::NaiveDate;
///
/// let data = BillingPeriodData {
///     period_start: Some(NaiveDate::from_ymd_opt(2024, 1, 1).unwrap()),
///     period_end: Some(NaiveDate::from_ymd_opt(2024, 12, 31).unwrap()),
///     consumption_value: Some(3500.0),
///     consumption_unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Abrechnungsperiodendaten"))]
#[serde(rename_all = "camelCase")]
pub struct BillingPeriodData {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Start of billing period (Abrechnungsbeginn)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "abrechnungsbeginn"))]
    pub period_start: Option<NaiveDate>,

    /// End of billing period (Abrechnungsende)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "abrechnungsende"))]
    pub period_end: Option<NaiveDate>,

    /// Starting meter reading (Anfangsstand)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "anfangsstand"))]
    pub start_reading: Option<f64>,

    /// Starting reading timestamp (Anfangsablesung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "anfangsablesung"))]
    pub start_reading_timestamp: Option<DateTime<Utc>>,

    /// Ending meter reading (Endstand)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "endstand"))]
    pub end_reading: Option<f64>,

    /// Ending reading timestamp (Endablesung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "endablesung"))]
    pub end_reading_timestamp: Option<DateTime<Utc>>,

    /// Consumption value for the period (Verbrauchswert)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "verbrauchswert"))]
    pub consumption_value: Option<f64>,

    /// Unit of consumption (Verbrauchseinheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "verbrauchseinheit"))]
    pub consumption_unit: Option<Unit>,

    /// Number of days in period (Anzahl Tage)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "anzahlTage"))]
    pub days_in_period: Option<i32>,
}

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

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

    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_billing_period_data() {
        let data = BillingPeriodData {
            period_start: Some(NaiveDate::from_ymd_opt(2024, 1, 1).unwrap()),
            period_end: Some(NaiveDate::from_ymd_opt(2024, 12, 31).unwrap()),
            start_reading: Some(10000.0),
            end_reading: Some(13500.0),
            consumption_value: Some(3500.0),
            consumption_unit: Some(Unit::KilowattHour),
            days_in_period: Some(366),
            ..Default::default()
        };

        let json = serde_json::to_string(&data).unwrap();
        assert!(json.contains("3500"));
    }

    #[test]
    fn test_roundtrip() {
        let data = BillingPeriodData {
            period_start: Some(NaiveDate::from_ymd_opt(2024, 1, 1).unwrap()),
            period_end: Some(NaiveDate::from_ymd_opt(2024, 6, 30).unwrap()),
            consumption_value: Some(1750.0),
            ..Default::default()
        };

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

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