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

//! Network location (Netzlokation) business object.
//!
//! Represents a location in the electricity or gas network.

use serde::{Deserialize, Serialize};

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

/// A network location - a point in the electricity or gas network.
///
/// German: Netzlokation
///
/// A network location represents a physical point in the network
/// infrastructure where energy flows.
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::NetworkLocation;
/// use bo4e_core::enums::Division;
///
/// let nelo = NetworkLocation {
///     network_location_id: Some("NELO12345".to_string()),
///     division: Some(Division::Electricity),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NetworkLocation {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Network location ID (Netzlokations-ID)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub network_location_id: Option<String>,

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

    /// Network level (Netzebene)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub network_level: Option<NetworkLevel>,

    /// Location address (Adresse)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<Address>,

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

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

    /// Associated metering location IDs
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub metering_location_ids: Vec<String>,

    /// Associated technical resource IDs
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub technical_resource_ids: Vec<String>,
}

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

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

    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_network_location_creation() {
        let nelo = NetworkLocation {
            network_location_id: Some("NELO12345".to_string()),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        assert_eq!(nelo.network_location_id, Some("NELO12345".to_string()));
    }

    #[test]
    fn test_serialize() {
        let nelo = NetworkLocation {
            meta: Bo4eMeta::with_type("Netzlokation"),
            network_location_id: Some("NELO12345".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&nelo).unwrap();
        assert!(json.contains(r#""_typ":"Netzlokation""#));
    }

    #[test]
    fn test_roundtrip() {
        let nelo = NetworkLocation {
            meta: Bo4eMeta::with_type("Netzlokation"),
            network_location_id: Some("NELO12345".to_string()),
            division: Some(Division::Electricity),
            network_level: Some(NetworkLevel::LowVoltage),
            ..Default::default()
        };

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

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