flowsdk 0.4.2

Safety-first, realistic, behavior-predictable messaging SDK for MQTT and more.
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

// SPDX-License-Identifier: MPL-2.0

use crate::mqtt_serde::mqttv5::common::properties::{parse_properties_hdr, Property};
use crate::mqtt_serde::parser::{parse_binary_data, parse_utf8_string, ParseError};
use serde::{Deserialize, Serialize};

#[derive(Debug, Default, PartialEq, Serialize, Deserialize, Clone)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub struct WillProperties {
    pub will_delay_interval: Option<u32>,
    pub payload_format_indicator: Option<u8>,
    pub message_expiry_interval: Option<u32>,
    pub content_type: Option<String>,
    pub response_topic: Option<String>,
    pub correlation_data: Option<Vec<u8>>,
    pub user_properties: Vec<Property>,
}

impl WillProperties {
    pub fn new() -> Self {
        WillProperties::default()
    }
}

#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub struct Will {
    pub will_qos: u8,
    pub will_retain: bool,
    pub will_topic: String,
    pub will_message: Vec<u8>,
    pub properties: WillProperties,
}

impl Will {
    pub fn new(will_topic: String, will_message: Vec<u8>, will_qos: u8, will_retain: bool) -> Self {
        Will {
            will_qos,
            will_retain,
            will_topic,
            will_message,
            properties: WillProperties::new(),
        }
    }

    pub fn from_bytes(buffer: &[u8], connect_flags: u8) -> Result<(Self, usize), ParseError> {
        let mut offset = 0;

        // MQTT 5.0: 3.1.3.2 Will Properties
        let (properties, consumed) = parse_properties_hdr(buffer)?;
        offset += consumed;

        // MQTT 5.0: 3.1.3.3 Will Topic
        let (will_topic, consumed) = parse_utf8_string(&buffer[offset..])?;
        offset += consumed;

        // MQTT 5.0: 3.1.3.4 Will Payload
        let (will_message, consumed) = parse_binary_data(&buffer[offset..])?;
        offset += consumed;

        let will_qos = (connect_flags >> 3) & 0x03;
        let will_retain = (connect_flags & 0x20) != 0;

        let mut will = Will::new(will_topic, will_message, will_qos, will_retain);
        for property in properties {
            match property {
                // MQTT 5.0: 3.1.3.2.2 Will Delay Interval
                Property::WillDelayInterval(value) => {
                    will.properties.will_delay_interval = Some(value)
                }
                // MQTT 5.0: 3.1.3.2.3 Payload format indicator
                Property::PayloadFormatIndicator(value) => {
                    will.properties.payload_format_indicator = Some(value)
                }
                // MQTT 5.0: 3.1.3.2.4 Message Expiry Interval
                Property::MessageExpiryInterval(value) => {
                    will.properties.message_expiry_interval = Some(value);
                }
                // MQTT 5.0: 3.1.3.2.5 Content Type
                Property::ContentType(value) => will.properties.content_type = Some(value),
                // MQTT 5.0: 3.1.3.2.6 Response Topic
                Property::ResponseTopic(value) => will.properties.response_topic = Some(value),
                // MQTT 5.0: 3.1.3.2.7 Correlation Data
                Property::CorrelationData(value) => will.properties.correlation_data = Some(value),
                // MQTT 5.0: 3.1.3.2.8 UserProperty
                _ => {
                    if let Property::UserProperty(key, value) = property {
                        will.properties
                            .user_properties
                            .push(Property::UserProperty(key, value));
                    }
                }
            }
        }

        Ok((will, offset))
    }
}