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

//! Contract part (Vertragsteil) component.

use serde::{Deserialize, Serialize};

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

/// Part of a contract linking a service to a location.
///
/// Used to represent a contractual service in relation to a location
/// (market or metering location). Contracts for multiple locations are
/// modeled with multiple contract parts.
///
/// German: Vertragsteil
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::ContractPart;
///
/// let part = ContractPart {
///     location_id: Some("DE0001234567890123456789012345678".to_string()),
///     contract_part_start: Some("2024-01-01T00:00:00+01:00".to_string()),
///     contract_part_end: Some("2024-12-31T23:59:59+01:00".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContractPart {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Start of the contract part validity (inclusive) (Vertragsteilbeginn)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract_part_start: Option<String>,

    /// End of the contract part validity (exclusive) (Vertragsteilende)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract_part_end: Option<String>,

    /// Identifier for the market or metering location belonging to this contract part (Lokation)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_id: Option<String>,

    // Note: The following fields would typically reference Menge COM type.
    // Using simplified f64 values for now.
    /// Contractually fixed consumption quantity (Vertraglich fixierte Menge)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fixed_quantity_value: Option<f64>,

    /// Minimum consumption quantity (inclusive) (Minimale Abnahmemenge)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub minimum_quantity_value: Option<f64>,

    /// Maximum consumption quantity (exclusive) (Maximale Abnahmemenge)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maximum_quantity_value: Option<f64>,
}

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

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

    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_contract_part_default() {
        let part = ContractPart::default();
        assert!(part.location_id.is_none());
        assert!(part.contract_part_start.is_none());
    }

    #[test]
    fn test_contract_part_serialize() {
        let part = ContractPart {
            location_id: Some("DE00012345678901234567890123456".to_string()),
            contract_part_start: Some("2024-01-01T00:00:00+01:00".to_string()),
            contract_part_end: Some("2024-12-31T23:59:59+01:00".to_string()),
            fixed_quantity_value: Some(50000.0),
            ..Default::default()
        };

        let json = serde_json::to_string(&part).unwrap();
        assert!(json.contains(r#""locationId":"DE00012345678901234567890123456""#));
        assert!(json.contains(r#""contractPartStart":"#));
        assert!(json.contains(r#""fixedQuantityValue":50000"#));
    }

    #[test]
    fn test_contract_part_roundtrip() {
        let part = ContractPart {
            meta: Bo4eMeta::with_type("Vertragsteil"),
            contract_part_start: Some("2024-06-01T00:00:00+02:00".to_string()),
            contract_part_end: Some("2025-05-31T23:59:59+02:00".to_string()),
            location_id: Some("MALO-12345".to_string()),
            fixed_quantity_value: Some(100000.0),
            minimum_quantity_value: Some(80000.0),
            maximum_quantity_value: Some(120000.0),
        };

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

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