summaryrefslogtreecommitdiffstats
path: root/src/properties.rs
blob: 2920b2c15515ae3bafe21b6cbea698bbc3c121a6 (plain)
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
//
//   This Source Code Form is subject to the terms of the Mozilla Public
//   License, v. 2.0. If a copy of the MPL was not distributed with this
//   file, You can obtain one at http://mozilla.org/MPL/2.0/.
//

pub type TypeOfProperty<P> = <P as FormatProperty>::Inner;

macro_rules! define_properties {
    (@no_lt $name:ident $pat:ident $lt:lifetime) => {
       type $name<'a> = mqtt_format::v5::variable_header:: $pat <'a>;
    };
    (@no_lt $name:ident $pat:ident) => {
       type $name = mqtt_format::v5::variable_header:: $pat;
    };

    (@statify $pat:ident $lt:lifetime) => {
       mqtt_format::v5::variable_header:: $pat <'static>
    };
    (@statify $pat:ident) => {
        mqtt_format::v5::variable_header:: $pat
    };
    (
        properties_type: $packettypename:ty,
        $( anker: $anker:literal $(,)?)?
        pub struct $name:ident {
            $( $((anker: $prop_anker:literal ))? $prop_name:ident : $prop:ident $(<$prop_lt:lifetime>)? with setter = $setter:ty),* $(,)?
        }
    ) => {
        #[derive(Clone, Debug, PartialEq)]
        pub struct $name {
            $(
                pub(crate) $prop_name: Option<crate::properties::TypeOfProperty<crate::properties::define_properties!(@statify $prop $($prop_lt)?)>>
            ),*
        }

        paste::paste! {
            #[allow(dead_code)]
            impl $name {
                #[allow(clippy::new_without_default)]
                pub fn new() -> Self {
                    $name {
                        $($prop_name: None),*
                    }
                }

                $(
                    #[doc = core::concat!("Set the ", stringify!($prop_name), " property.") ]
                    $( #[doc = core::concat!("See also: ", crate::util::md_speclink!($prop_anker)) ] )?
                    pub fn [<with_ $prop_name>](&mut self, value: $setter) -> &mut Self {
                        <crate::properties::define_properties!(@statify $prop $($prop_lt)?) as crate::properties::FormatProperty>::apply(&mut self.$prop_name, value);

                        self
                    }
                )*

                pub fn as_ref(&self) -> $packettypename {
                    $packettypename {
                        $($prop_name: {
                            self.$prop_name.as_ref().map(|v| {
                                crate::properties::define_properties!(@no_lt Prop $prop $($prop_lt)?);
                                Prop {
                                    0: <crate::properties::define_properties!(@statify $prop $($prop_lt)?) as crate::properties::FormatProperty>::get(v)
                                }
                            })
                        }),*
                    }
                }
            }
        }
    };
}
pub(crate) use define_properties;

use crate::packets::VecWriter;
use crate::string::MqttString;

pub struct UserProperty {
    key: MqttString,
    value: MqttString,
}

pub(crate) trait FormatProperty {
    type Inner;
    type Setter;
    type Outer<'a>;

    fn apply(inner: &mut Option<Self::Inner>, value: impl Into<Self::Setter>);

    fn get(inner: &Self::Inner) -> Self::Outer<'_>;
}

impl<'i> FormatProperty for mqtt_format::v5::variable_header::UserProperties<'i> {
    type Inner = Vec<u8>;
    type Setter = UserProperty;
    type Outer<'a> = &'a [u8];

    fn apply(inner: &mut Option<Self::Inner>, key_value: impl Into<Self::Setter>) {
        let key_value = key_value.into();
        let user_prop = mqtt_format::v5::variable_header::UserProperty {
            key: key_value.key.as_ref(),
            value: key_value.value.as_ref(),
        };
        let inner = inner.get_or_insert_with(Default::default);
        if !inner.is_empty() {
            mqtt_format::v5::integers::write_variable_u32(
                &mut VecWriter(inner),
                <mqtt_format::v5::variable_header::UserProperties as mqtt_format::v5::variable_header::MqttProperties>::IDENTIFIER,
            )
            .expect("Writing a u32 should not fail")
        }
        user_prop
            .write(&mut VecWriter(inner))
            .expect("Writing MqttStrings should never be invalid");
    }

    fn get(inner: &Self::Inner) -> Self::Outer<'_> {
        inner.as_ref()
    }
}

macro_rules! define_property_types {
    (@access_pattern ref $value:ident) => {
        $value.as_ref()
    };
    (@access_pattern deref $value:ident) => {
        *$value
    };
    ([ $( $prop:ty => inner = $inner:ty; setter = $setter:ty; outer $mode:tt = $outer:ty ),* $(,)? ]) => {
        $(
            impl<'i> FormatProperty for $prop {
                type Inner = $inner;
                type Setter = $setter;
                type Outer<'a> = $outer;

                fn apply(inner: &mut Option<Self::Inner>, value: impl Into<Self::Setter>) {
                    *inner = Some(value.into());
                }

                fn get(inner: &Self::Inner) -> Self::Outer<'_> {
                    define_property_types!(@access_pattern $mode inner)
                }
            }
        )*
    };
}

define_property_types! {[
    mqtt_format::v5::variable_header::PayloadFormatIndicator => inner = u8; setter = u8; outer deref = u8,
    mqtt_format::v5::variable_header::MessageExpiryInterval => inner = u32; setter = u32; outer deref = u32,
    mqtt_format::v5::variable_header::ContentType<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::ResponseTopic<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::CorrelationData<'i> => inner = Vec<u8>; setter = Vec<u8>; outer ref = &'a [u8],
    mqtt_format::v5::variable_header::SubscriptionIdentifier => inner = u32; setter = u32; outer deref = u32,
    mqtt_format::v5::variable_header::SessionExpiryInterval => inner = u32; setter = u32; outer deref = u32,
    mqtt_format::v5::variable_header::AssignedClientIdentifier<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::ServerKeepAlive => inner = u16; setter = u16; outer deref = u16,
    mqtt_format::v5::variable_header::AuthenticationMethod<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::AuthenticationData<'i> => inner = Vec<u8>; setter = Vec<u8>; outer ref = &'a [u8],
    mqtt_format::v5::variable_header::RequestProblemInformation => inner = u8; setter = u8; outer deref = u8,
    mqtt_format::v5::variable_header::WillDelayInterval => inner = u32; setter = u32; outer deref = u32,
    mqtt_format::v5::variable_header::RequestResponseInformation => inner = u8; setter = u8; outer deref = u8,
    mqtt_format::v5::variable_header::ResponseInformation<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::ServerReference<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::ReasonString<'i> => inner = String; setter = String; outer ref = &'a str,
    mqtt_format::v5::variable_header::ReceiveMaximum => inner = core::num::NonZeroU16; setter = core::num::NonZeroU16; outer deref = core::num::NonZeroU16,
    mqtt_format::v5::variable_header::TopicAliasMaximum => inner = u16; setter = u16; outer deref = u16,
    mqtt_format::v5::variable_header::TopicAlias => inner = u16; setter = u16; outer deref = u16,