rustbac-core 0.4.0

Core BACnet protocol types, encoders, and service codecs for rustbac.
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

use crate::apdu::ConfirmedRequestHeader;
use crate::encoding::{
    primitives::{encode_ctx_object_id, encode_ctx_unsigned},
    tag::Tag,
    writer::Writer,
};
use crate::services::value_codec::encode_application_data_value;
use crate::types::{DataValue, ObjectId, PropertyId};
use crate::EncodeError;

pub const SERVICE_ADD_LIST_ELEMENT: u8 = 0x08;
pub const SERVICE_REMOVE_LIST_ELEMENT: u8 = 0x09;

#[derive(Debug, Clone, PartialEq)]
pub struct AddListElementRequest<'a> {
    pub object_id: ObjectId,
    pub property_id: PropertyId,
    pub array_index: Option<u32>,
    pub elements: &'a [DataValue<'a>],
    pub invoke_id: u8,
}

impl<'a> AddListElementRequest<'a> {
    pub fn encode(&self, w: &mut Writer<'_>) -> Result<(), EncodeError> {
        encode_list_element_request(w, self, SERVICE_ADD_LIST_ELEMENT)
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct RemoveListElementRequest<'a> {
    pub object_id: ObjectId,
    pub property_id: PropertyId,
    pub array_index: Option<u32>,
    pub elements: &'a [DataValue<'a>],
    pub invoke_id: u8,
}

impl<'a> RemoveListElementRequest<'a> {
    pub fn encode(&self, w: &mut Writer<'_>) -> Result<(), EncodeError> {
        encode_list_element_request(
            w,
            &AddListElementRequest {
                object_id: self.object_id,
                property_id: self.property_id,
                array_index: self.array_index,
                elements: self.elements,
                invoke_id: self.invoke_id,
            },
            SERVICE_REMOVE_LIST_ELEMENT,
        )
    }
}

fn encode_list_element_request(
    w: &mut Writer<'_>,
    req: &AddListElementRequest<'_>,
    service_choice: u8,
) -> Result<(), EncodeError> {
    ConfirmedRequestHeader {
        segmented: false,
        more_follows: false,
        segmented_response_accepted: false,
        max_segments: 0,
        max_apdu: 5,
        invoke_id: req.invoke_id,
        sequence_number: None,
        proposed_window_size: None,
        service_choice,
    }
    .encode(w)?;
    encode_ctx_object_id(w, 0, req.object_id.raw())?;
    encode_ctx_unsigned(w, 1, req.property_id.to_u32())?;
    if let Some(array_index) = req.array_index {
        encode_ctx_unsigned(w, 2, array_index)?;
    }
    Tag::Opening { tag_num: 3 }.encode(w)?;
    for value in req.elements {
        encode_application_data_value(w, value)?;
    }
    Tag::Closing { tag_num: 3 }.encode(w)?;
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::{
        AddListElementRequest, RemoveListElementRequest, SERVICE_ADD_LIST_ELEMENT,
        SERVICE_REMOVE_LIST_ELEMENT,
    };
    use crate::apdu::ConfirmedRequestHeader;
    use crate::encoding::{reader::Reader, writer::Writer};
    use crate::types::{DataValue, ObjectId, ObjectType, PropertyId};

    #[test]
    fn encode_add_list_element_request() {
        let values = [DataValue::Unsigned(1), DataValue::Unsigned(2)];
        let req = AddListElementRequest {
            object_id: ObjectId::new(ObjectType::AnalogValue, 1),
            property_id: PropertyId::Proprietary(512),
            array_index: None,
            elements: &values,
            invoke_id: 7,
        };
        let mut buf = [0u8; 128];
        let mut w = Writer::new(&mut buf);
        req.encode(&mut w).unwrap();
        let mut r = Reader::new(w.as_written());
        let hdr = ConfirmedRequestHeader::decode(&mut r).unwrap();
        assert_eq!(hdr.service_choice, SERVICE_ADD_LIST_ELEMENT);
    }

    #[test]
    fn encode_remove_list_element_request() {
        let values = [DataValue::Enumerated(3)];
        let req = RemoveListElementRequest {
            object_id: ObjectId::new(ObjectType::TrendLog, 1),
            property_id: PropertyId::Proprietary(513),
            array_index: None,
            elements: &values,
            invoke_id: 8,
        };
        let mut buf = [0u8; 128];
        let mut w = Writer::new(&mut buf);
        req.encode(&mut w).unwrap();
        let mut r = Reader::new(w.as_written());
        let hdr = ConfirmedRequestHeader::decode(&mut r).unwrap();
        assert_eq!(hdr.service_choice, SERVICE_REMOVE_LIST_ELEMENT);
    }
}