Pilot v2: Core implementation + battery telemetry

Major updates:
- Complete Rust rewrite (pilot-v2/) with working MQTT client
- Fixed MQTT event loop deadlock (background task pattern)
- Battery telemetry for Linux (auto-detected via /sys/class/power_supply)
- Home Assistant auto-discovery for all sensors and switches
- Comprehensive documentation (AVANCEMENT.md, CLAUDE.md, roadmap)
- Docker test environment with Mosquitto broker
- Helper scripts for development and testing

Features working:
✅ MQTT connectivity with LWT
✅ YAML configuration with validation
✅ Telemetry: CPU, memory, IP, battery (Linux)
✅ Commands: shutdown, reboot, sleep, screen (dry-run tested)
✅ HA discovery and integration
✅ Allowlist and cooldown protection

Ready for testing on real hardware.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Gilles Soulier
2025-12-30 06:23:00 +01:00
co-authored by Claude Sonnet 4.5
parent b7e67c6501
commit c5381b7112
4453 changed files with 78647 additions and 0 deletions
@@ -0,0 +1,186 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::{str::Utf8Error, vec};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="doccomment">/// This module is the place where all the protocol specifics gets abstracted
<a href=#4 id=4 data-nosnippet>4</a>/// out and creates a structures which are common across protocols. Since,
<a href=#5 id=5 data-nosnippet>5</a>/// MQTT is the core protocol that this broker supports, a lot of structs closely
<a href=#6 id=6 data-nosnippet>6</a>/// map to what MQTT specifies in its protocol
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub mod </span>v5;
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="doccomment">/// Quality of service
<a href=#10 id=10 data-nosnippet>10</a></span><span class="attr">#[repr(u8)]
<a href=#11 id=11 data-nosnippet>11</a>#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
<a href=#12 id=12 data-nosnippet>12</a>#[allow(clippy::enum_variant_names)]
<a href=#13 id=13 data-nosnippet>13</a></span><span class="kw">pub enum </span>QoS {
<a href=#14 id=14 data-nosnippet>14</a> AtMostOnce = <span class="number">0</span>,
<a href=#15 id=15 data-nosnippet>15</a> AtLeastOnce = <span class="number">1</span>,
<a href=#16 id=16 data-nosnippet>16</a> ExactlyOnce = <span class="number">2</span>,
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">impl </span>Default <span class="kw">for </span>QoS {
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#21 id=21 data-nosnippet>21</a> <span class="self">Self</span>::AtMostOnce
<a href=#22 id=22 data-nosnippet>22</a> }
<a href=#23 id=23 data-nosnippet>23</a>}
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="doccomment">/// Maps a number to QoS
<a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">pub fn </span>qos(num: u8) -&gt; <span class="prelude-ty">Option</span>&lt;QoS&gt; {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">match </span>num {
<a href=#28 id=28 data-nosnippet>28</a> <span class="number">0 </span>=&gt; <span class="prelude-val">Some</span>(QoS::AtMostOnce),
<a href=#29 id=29 data-nosnippet>29</a> <span class="number">1 </span>=&gt; <span class="prelude-val">Some</span>(QoS::AtLeastOnce),
<a href=#30 id=30 data-nosnippet>30</a> <span class="number">2 </span>=&gt; <span class="prelude-val">Some</span>(QoS::ExactlyOnce),
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a>}
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="doccomment">/// Checks if a topic or topic filter has wildcards
<a href=#36 id=36 data-nosnippet>36</a></span><span class="kw">pub fn </span>has_wildcards(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#37 id=37 data-nosnippet>37</a> s.contains(<span class="string">'+'</span>) || s.contains(<span class="string">'#'</span>)
<a href=#38 id=38 data-nosnippet>38</a>}
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a><span class="doccomment">/// Checks if a topic is valid
<a href=#41 id=41 data-nosnippet>41</a></span><span class="kw">pub fn </span>valid_topic(topic: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#42 id=42 data-nosnippet>42</a> <span class="comment">// topic can't contain wildcards
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">if </span>topic.contains(<span class="string">'+'</span>) || topic.contains(<span class="string">'#'</span>) {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="bool-val">true
<a href=#48 id=48 data-nosnippet>48</a></span>}
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a><span class="doccomment">/// Checks if the filter is valid
<a href=#51 id=51 data-nosnippet>51</a>///
<a href=#52 id=52 data-nosnippet>52</a>/// &lt;https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106&gt;
<a href=#53 id=53 data-nosnippet>53</a></span><span class="kw">pub fn </span>valid_filter(filter: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">if </span>filter.is_empty() {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#56 id=56 data-nosnippet>56</a> }
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="comment">// rev() is used so we can easily get the last entry
<a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">let </span><span class="kw-2">mut </span>hirerarchy = filter.split(<span class="string">'/'</span>).rev();
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="comment">// split will never return an empty iterator
<a href=#62 id=62 data-nosnippet>62</a> // even if the pattern isn't matched, the original string will be there
<a href=#63 id=63 data-nosnippet>63</a> // so it is safe to just unwrap here!
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">let </span>last = hirerarchy.next().unwrap();
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> <span class="comment">// only single '#" or '+' is allowed in last entry
<a href=#67 id=67 data-nosnippet>67</a> // invalid: sport/tennis#
<a href=#68 id=68 data-nosnippet>68</a> // invalid: sport/++
<a href=#69 id=69 data-nosnippet>69</a> </span><span class="kw">if </span>last.len() != <span class="number">1 </span>&amp;&amp; (last.contains(<span class="string">'#'</span>) || last.contains(<span class="string">'+'</span>)) {
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="comment">// remaining entries
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">for </span>entry <span class="kw">in </span>hirerarchy {
<a href=#75 id=75 data-nosnippet>75</a> <span class="comment">// # is not allowed in filter except as a last entry
<a href=#76 id=76 data-nosnippet>76</a> // invalid: sport/tennis#/player
<a href=#77 id=77 data-nosnippet>77</a> // invalid: sport/tennis/#/ranking
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">if </span>entry.contains(<span class="string">'#'</span>) {
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="comment">// + must occupy an entire level of the filter
<a href=#83 id=83 data-nosnippet>83</a> // invalid: sport+
<a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">if </span>entry.len() &gt; <span class="number">1 </span>&amp;&amp; entry.contains(<span class="string">'+'</span>) {
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#86 id=86 data-nosnippet>86</a> }
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="bool-val">true
<a href=#90 id=90 data-nosnippet>90</a></span>}
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a><span class="doccomment">/// Checks if topic matches a filter. topic and filter validation isn't done here.
<a href=#93 id=93 data-nosnippet>93</a>///
<a href=#94 id=94 data-nosnippet>94</a>/// **NOTE**: 'topic' is a misnomer in the arg. this can also be used to match 2 wild subscriptions
<a href=#95 id=95 data-nosnippet>95</a>/// **NOTE**: make sure a topic is validated during a publish and filter is validated
<a href=#96 id=96 data-nosnippet>96</a>/// during a subscribe
<a href=#97 id=97 data-nosnippet>97</a></span><span class="kw">pub fn </span>matches(topic: <span class="kw-2">&amp;</span>str, filter: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">if </span>!topic.is_empty() &amp;&amp; topic[..<span class="number">1</span>].contains(<span class="string">'$'</span>) {
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#100 id=100 data-nosnippet>100</a> }
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span><span class="kw-2">mut </span>topics = topic.split(<span class="string">'/'</span>);
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span><span class="kw-2">mut </span>filters = filter.split(<span class="string">'/'</span>);
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">for </span>f <span class="kw">in </span>filters.by_ref() {
<a href=#106 id=106 data-nosnippet>106</a> <span class="comment">// "#" being the last element is validated by the broker with 'valid_filter'
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">if </span>f == <span class="string">"#" </span>{
<a href=#108 id=108 data-nosnippet>108</a> <span class="kw">return </span><span class="bool-val">true</span>;
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> <span class="comment">// filter still has remaining elements
<a href=#112 id=112 data-nosnippet>112</a> // filter = a/b/c/# should match topci = a/b/c
<a href=#113 id=113 data-nosnippet>113</a> // filter = a/b/c/d should not match topic = a/b/c
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">let </span>top = topics.next();
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">match </span>top {
<a href=#116 id=116 data-nosnippet>116</a> <span class="prelude-val">Some</span>(<span class="string">"#"</span>) =&gt; <span class="kw">return </span><span class="bool-val">false</span>,
<a href=#117 id=117 data-nosnippet>117</a> <span class="prelude-val">Some</span>(<span class="kw">_</span>) <span class="kw">if </span>f == <span class="string">"+" </span>=&gt; <span class="kw">continue</span>,
<a href=#118 id=118 data-nosnippet>118</a> <span class="prelude-val">Some</span>(t) <span class="kw">if </span>f != t =&gt; <span class="kw">return </span><span class="bool-val">false</span>,
<a href=#119 id=119 data-nosnippet>119</a> <span class="prelude-val">Some</span>(<span class="kw">_</span>) =&gt; <span class="kw">continue</span>,
<a href=#120 id=120 data-nosnippet>120</a> <span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="bool-val">false</span>,
<a href=#121 id=121 data-nosnippet>121</a> }
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="comment">// topic has remaining elements and filter's last element isn't "#"
<a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">if </span>topics.next().is_some() {
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="bool-val">true
<a href=#130 id=130 data-nosnippet>130</a></span>}
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a><span class="doccomment">/// Error during serialization and deserialization
<a href=#133 id=133 data-nosnippet>133</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
<a href=#134 id=134 data-nosnippet>134</a></span><span class="kw">pub enum </span>Error {
<a href=#135 id=135 data-nosnippet>135</a> <span class="attr">#[error(<span class="string">"Invalid return code received as response for connect = {0}"</span>)]
<a href=#136 id=136 data-nosnippet>136</a> </span>InvalidConnectReturnCode(u8),
<a href=#137 id=137 data-nosnippet>137</a> <span class="attr">#[error(<span class="string">"Invalid reason = {0}"</span>)]
<a href=#138 id=138 data-nosnippet>138</a> </span>InvalidReason(u8),
<a href=#139 id=139 data-nosnippet>139</a> <span class="attr">#[error(<span class="string">"Invalid remaining length = {0}"</span>)]
<a href=#140 id=140 data-nosnippet>140</a> </span>InvalidRemainingLength(usize),
<a href=#141 id=141 data-nosnippet>141</a> <span class="attr">#[error(<span class="string">"Invalid protocol used"</span>)]
<a href=#142 id=142 data-nosnippet>142</a> </span>InvalidProtocol,
<a href=#143 id=143 data-nosnippet>143</a> <span class="attr">#[error(<span class="string">"Invalid protocol level"</span>)]
<a href=#144 id=144 data-nosnippet>144</a> </span>InvalidProtocolLevel(u8),
<a href=#145 id=145 data-nosnippet>145</a> <span class="attr">#[error(<span class="string">"Invalid packet format"</span>)]
<a href=#146 id=146 data-nosnippet>146</a> </span>IncorrectPacketFormat,
<a href=#147 id=147 data-nosnippet>147</a> <span class="attr">#[error(<span class="string">"Invalid packet type = {0}"</span>)]
<a href=#148 id=148 data-nosnippet>148</a> </span>InvalidPacketType(u8),
<a href=#149 id=149 data-nosnippet>149</a> <span class="attr">#[error(<span class="string">"Invalid retain forward rule = {0}"</span>)]
<a href=#150 id=150 data-nosnippet>150</a> </span>InvalidRetainForwardRule(u8),
<a href=#151 id=151 data-nosnippet>151</a> <span class="attr">#[error(<span class="string">"Invalid QoS level = {0}"</span>)]
<a href=#152 id=152 data-nosnippet>152</a> </span>InvalidQoS(u8),
<a href=#153 id=153 data-nosnippet>153</a> <span class="attr">#[error(<span class="string">"Invalid subscribe reason code = {0}"</span>)]
<a href=#154 id=154 data-nosnippet>154</a> </span>InvalidSubscribeReasonCode(u8),
<a href=#155 id=155 data-nosnippet>155</a> <span class="attr">#[error(<span class="string">"Packet received has id Zero"</span>)]
<a href=#156 id=156 data-nosnippet>156</a> </span>PacketIdZero,
<a href=#157 id=157 data-nosnippet>157</a> <span class="attr">#[error(<span class="string">"Empty Subscription"</span>)]
<a href=#158 id=158 data-nosnippet>158</a> </span>EmptySubscription,
<a href=#159 id=159 data-nosnippet>159</a> <span class="attr">#[error(<span class="string">"Subscription had id Zero"</span>)]
<a href=#160 id=160 data-nosnippet>160</a> </span>SubscriptionIdZero,
<a href=#161 id=161 data-nosnippet>161</a> <span class="attr">#[error(<span class="string">"Payload size is incorrect"</span>)]
<a href=#162 id=162 data-nosnippet>162</a> </span>PayloadSizeIncorrect,
<a href=#163 id=163 data-nosnippet>163</a> <span class="attr">#[error(<span class="string">"Payload is too long"</span>)]
<a href=#164 id=164 data-nosnippet>164</a> </span>PayloadTooLong,
<a href=#165 id=165 data-nosnippet>165</a> <span class="attr">#[error(<span class="string">"Max Payload size of {max:?} has been exceeded by packet of {pkt_size:?} bytes"</span>)]
<a href=#166 id=166 data-nosnippet>166</a> </span>PayloadSizeLimitExceeded { pkt_size: usize, max: usize },
<a href=#167 id=167 data-nosnippet>167</a> <span class="attr">#[error(<span class="string">"Payload is required"</span>)]
<a href=#168 id=168 data-nosnippet>168</a> </span>PayloadRequired,
<a href=#169 id=169 data-nosnippet>169</a> <span class="attr">#[error(<span class="string">"Payload is required = {0}"</span>)]
<a href=#170 id=170 data-nosnippet>170</a> </span>PayloadNotUtf8(<span class="attr">#[from] </span>Utf8Error),
<a href=#171 id=171 data-nosnippet>171</a> <span class="attr">#[error(<span class="string">"Topic not utf-8"</span>)]
<a href=#172 id=172 data-nosnippet>172</a> </span>TopicNotUtf8,
<a href=#173 id=173 data-nosnippet>173</a> <span class="attr">#[error(<span class="string">"Promised boundary crossed, contains {0} bytes"</span>)]
<a href=#174 id=174 data-nosnippet>174</a> </span>BoundaryCrossed(usize),
<a href=#175 id=175 data-nosnippet>175</a> <span class="attr">#[error(<span class="string">"Packet is malformed"</span>)]
<a href=#176 id=176 data-nosnippet>176</a> </span>MalformedPacket,
<a href=#177 id=177 data-nosnippet>177</a> <span class="attr">#[error(<span class="string">"Remaining length is malformed"</span>)]
<a href=#178 id=178 data-nosnippet>178</a> </span>MalformedRemainingLength,
<a href=#179 id=179 data-nosnippet>179</a> <span class="attr">#[error(<span class="string">"Invalid property type = {0}"</span>)]
<a href=#180 id=180 data-nosnippet>180</a> </span>InvalidPropertyType(u8),
<a href=#181 id=181 data-nosnippet>181</a> <span class="doccomment">/// More bytes required to frame packet. Argument
<a href=#182 id=182 data-nosnippet>182</a> /// implies minimum additional bytes required to
<a href=#183 id=183 data-nosnippet>183</a> /// proceed further
<a href=#184 id=184 data-nosnippet>184</a> </span><span class="attr">#[error(<span class="string">"Insufficient number of bytes to frame packet, {0} more bytes required"</span>)]
<a href=#185 id=185 data-nosnippet>185</a> </span>InsufficientBytes(usize),
<a href=#186 id=186 data-nosnippet>186</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,530 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/connack.rs`."><title>connack.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>connack.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Return code in connack
<a href=#5 id=5 data-nosnippet>5</a></span><span class="comment">// This contains return codes for both MQTT v311 and v5
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub enum </span>ConnectReturnCode {
<a href=#8 id=8 data-nosnippet>8</a> Success,
<a href=#9 id=9 data-nosnippet>9</a> RefusedProtocolVersion,
<a href=#10 id=10 data-nosnippet>10</a> BadClientId,
<a href=#11 id=11 data-nosnippet>11</a> ServiceUnavailable,
<a href=#12 id=12 data-nosnippet>12</a> UnspecifiedError,
<a href=#13 id=13 data-nosnippet>13</a> MalformedPacket,
<a href=#14 id=14 data-nosnippet>14</a> ProtocolError,
<a href=#15 id=15 data-nosnippet>15</a> ImplementationSpecificError,
<a href=#16 id=16 data-nosnippet>16</a> UnsupportedProtocolVersion,
<a href=#17 id=17 data-nosnippet>17</a> ClientIdentifierNotValid,
<a href=#18 id=18 data-nosnippet>18</a> BadUserNamePassword,
<a href=#19 id=19 data-nosnippet>19</a> NotAuthorized,
<a href=#20 id=20 data-nosnippet>20</a> ServerUnavailable,
<a href=#21 id=21 data-nosnippet>21</a> ServerBusy,
<a href=#22 id=22 data-nosnippet>22</a> Banned,
<a href=#23 id=23 data-nosnippet>23</a> BadAuthenticationMethod,
<a href=#24 id=24 data-nosnippet>24</a> TopicNameInvalid,
<a href=#25 id=25 data-nosnippet>25</a> PacketTooLarge,
<a href=#26 id=26 data-nosnippet>26</a> QuotaExceeded,
<a href=#27 id=27 data-nosnippet>27</a> PayloadFormatInvalid,
<a href=#28 id=28 data-nosnippet>28</a> RetainNotSupported,
<a href=#29 id=29 data-nosnippet>29</a> QoSNotSupported,
<a href=#30 id=30 data-nosnippet>30</a> UseAnotherServer,
<a href=#31 id=31 data-nosnippet>31</a> ServerMoved,
<a href=#32 id=32 data-nosnippet>32</a> ConnectionRateExceeded,
<a href=#33 id=33 data-nosnippet>33</a>}
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="doccomment">/// Acknowledgement to connect packet
<a href=#36 id=36 data-nosnippet>36</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub struct </span>ConnAck {
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">pub </span>session_present: bool,
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">pub </span>code: ConnectReturnCode,
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;ConnAckProperties&gt;,
<a href=#41 id=41 data-nosnippet>41</a>}
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">impl </span>ConnAck {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">1 </span><span class="comment">// session present
<a href=#46 id=46 data-nosnippet>46</a> </span>+ <span class="number">1</span>; <span class="comment">// code
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span>properties_len = p.len();
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#51 id=51 data-nosnippet>51</a> len += properties_len_len + properties_len;
<a href=#52 id=52 data-nosnippet>52</a> } <span class="kw">else </span>{
<a href=#53 id=53 data-nosnippet>53</a> len += <span class="number">1</span>;
<a href=#54 id=54 data-nosnippet>54</a> }
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a> len
<a href=#57 id=57 data-nosnippet>57</a> }
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;ConnAck, Error&gt; {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#68 id=68 data-nosnippet>68</a> bytes.advance(variable_header_index);
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">let </span>flags = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">let </span>return_code = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>properties = ConnAckProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>session_present = (flags &amp; <span class="number">0x01</span>) == <span class="number">1</span>;
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>code = connect_return(return_code)<span class="question-mark">?</span>;
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>connack = ConnAck {
<a href=#77 id=77 data-nosnippet>77</a> session_present,
<a href=#78 id=78 data-nosnippet>78</a> code,
<a href=#79 id=79 data-nosnippet>79</a> properties,
<a href=#80 id=80 data-nosnippet>80</a> };
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="prelude-val">Ok</span>(connack)
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span>len = <span class="self">Self</span>::len(<span class="self">self</span>);
<a href=#87 id=87 data-nosnippet>87</a> buffer.put_u8(<span class="number">0x20</span>);
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#90 id=90 data-nosnippet>90</a> buffer.put_u8(<span class="self">self</span>.session_present <span class="kw">as </span>u8);
<a href=#91 id=91 data-nosnippet>91</a> buffer.put_u8(connect_code(<span class="self">self</span>.code));
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#94 id=94 data-nosnippet>94</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#95 id=95 data-nosnippet>95</a> } <span class="kw">else </span>{
<a href=#96 id=96 data-nosnippet>96</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#100 id=100 data-nosnippet>100</a> }
<a href=#101 id=101 data-nosnippet>101</a>}
<a href=#102 id=102 data-nosnippet>102</a>
<a href=#103 id=103 data-nosnippet>103</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#104 id=104 data-nosnippet>104</a></span><span class="kw">pub struct </span>ConnAckProperties {
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">pub </span>session_expiry_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">pub </span>receive_max: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub </span>max_qos: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#108 id=108 data-nosnippet>108</a> <span class="kw">pub </span>retain_available: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">pub </span>max_packet_size: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">pub </span>assigned_client_identifier: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">pub </span>topic_alias_max: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">pub </span>wildcard_subscription_available: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">pub </span>subscription_identifiers_available: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#116 id=116 data-nosnippet>116</a> <span class="kw">pub </span>shared_subscription_available: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">pub </span>server_keep_alive: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">pub </span>response_information: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">pub </span>server_reference: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">pub </span>authentication_method: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">pub </span>authentication_data: <span class="prelude-ty">Option</span>&lt;Bytes&gt;,
<a href=#122 id=122 data-nosnippet>122</a>}
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a><span class="kw">impl </span>ConnAckProperties {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">if </span><span class="self">self</span>.session_expiry_interval.is_some() {
<a href=#129 id=129 data-nosnippet>129</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">if </span><span class="self">self</span>.receive_max.is_some() {
<a href=#133 id=133 data-nosnippet>133</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">if </span><span class="self">self</span>.max_qos.is_some() {
<a href=#137 id=137 data-nosnippet>137</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a>
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">if </span><span class="self">self</span>.retain_available.is_some() {
<a href=#141 id=141 data-nosnippet>141</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#142 id=142 data-nosnippet>142</a> }
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">if </span><span class="self">self</span>.max_packet_size.is_some() {
<a href=#145 id=145 data-nosnippet>145</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#146 id=146 data-nosnippet>146</a> }
<a href=#147 id=147 data-nosnippet>147</a>
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(id) = <span class="kw-2">&amp;</span><span class="self">self</span>.assigned_client_identifier {
<a href=#149 id=149 data-nosnippet>149</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ id.len();
<a href=#150 id=150 data-nosnippet>150</a> }
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">if </span><span class="self">self</span>.topic_alias_max.is_some() {
<a href=#153 id=153 data-nosnippet>153</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#154 id=154 data-nosnippet>154</a> }
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#157 id=157 data-nosnippet>157</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#161 id=161 data-nosnippet>161</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#162 id=162 data-nosnippet>162</a> }
<a href=#163 id=163 data-nosnippet>163</a>
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">if </span><span class="self">self</span>.wildcard_subscription_available.is_some() {
<a href=#165 id=165 data-nosnippet>165</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#166 id=166 data-nosnippet>166</a> }
<a href=#167 id=167 data-nosnippet>167</a>
<a href=#168 id=168 data-nosnippet>168</a> <span class="kw">if </span><span class="self">self</span>.subscription_identifiers_available.is_some() {
<a href=#169 id=169 data-nosnippet>169</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#170 id=170 data-nosnippet>170</a> }
<a href=#171 id=171 data-nosnippet>171</a>
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">if </span><span class="self">self</span>.shared_subscription_available.is_some() {
<a href=#173 id=173 data-nosnippet>173</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#174 id=174 data-nosnippet>174</a> }
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">if </span><span class="self">self</span>.server_keep_alive.is_some() {
<a href=#177 id=177 data-nosnippet>177</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#178 id=178 data-nosnippet>178</a> }
<a href=#179 id=179 data-nosnippet>179</a>
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(info) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_information {
<a href=#181 id=181 data-nosnippet>181</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ info.len();
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reference) = <span class="kw-2">&amp;</span><span class="self">self</span>.server_reference {
<a href=#185 id=185 data-nosnippet>185</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reference.len();
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a>
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_method) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_method {
<a href=#189 id=189 data-nosnippet>189</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ authentication_method.len();
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_data) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_data {
<a href=#193 id=193 data-nosnippet>193</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ authentication_data.len();
<a href=#194 id=194 data-nosnippet>194</a> }
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a> len
<a href=#197 id=197 data-nosnippet>197</a> }
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;ConnAckProperties&gt;, Error&gt; {
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">let </span><span class="kw-2">mut </span>session_expiry_interval = <span class="prelude-val">None</span>;
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">let </span><span class="kw-2">mut </span>receive_max = <span class="prelude-val">None</span>;
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">let </span><span class="kw-2">mut </span>max_qos = <span class="prelude-val">None</span>;
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">let </span><span class="kw-2">mut </span>retain_available = <span class="prelude-val">None</span>;
<a href=#204 id=204 data-nosnippet>204</a> <span class="kw">let </span><span class="kw-2">mut </span>max_packet_size = <span class="prelude-val">None</span>;
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">let </span><span class="kw-2">mut </span>assigned_client_identifier = <span class="prelude-val">None</span>;
<a href=#206 id=206 data-nosnippet>206</a> <span class="kw">let </span><span class="kw-2">mut </span>topic_alias_max = <span class="prelude-val">None</span>;
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#208 id=208 data-nosnippet>208</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#209 id=209 data-nosnippet>209</a> <span class="kw">let </span><span class="kw-2">mut </span>wildcard_subscription_available = <span class="prelude-val">None</span>;
<a href=#210 id=210 data-nosnippet>210</a> <span class="kw">let </span><span class="kw-2">mut </span>subscription_identifiers_available = <span class="prelude-val">None</span>;
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">let </span><span class="kw-2">mut </span>shared_subscription_available = <span class="prelude-val">None</span>;
<a href=#212 id=212 data-nosnippet>212</a> <span class="kw">let </span><span class="kw-2">mut </span>server_keep_alive = <span class="prelude-val">None</span>;
<a href=#213 id=213 data-nosnippet>213</a> <span class="kw">let </span><span class="kw-2">mut </span>response_information = <span class="prelude-val">None</span>;
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">let </span><span class="kw-2">mut </span>server_reference = <span class="prelude-val">None</span>;
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span><span class="kw-2">mut </span>authentication_method = <span class="prelude-val">None</span>;
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">let </span><span class="kw-2">mut </span>authentication_data = <span class="prelude-val">None</span>;
<a href=#217 id=217 data-nosnippet>217</a>
<a href=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#219 id=219 data-nosnippet>219</a> bytes.advance(properties_len_len);
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#222 id=222 data-nosnippet>222</a> }
<a href=#223 id=223 data-nosnippet>223</a>
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#225 id=225 data-nosnippet>225</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#226 id=226 data-nosnippet>226</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#228 id=228 data-nosnippet>228</a> cursor += <span class="number">1</span>;
<a href=#229 id=229 data-nosnippet>229</a>
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#231 id=231 data-nosnippet>231</a> PropertyType::SessionExpiryInterval =&gt; {
<a href=#232 id=232 data-nosnippet>232</a> session_expiry_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#233 id=233 data-nosnippet>233</a> cursor += <span class="number">4</span>;
<a href=#234 id=234 data-nosnippet>234</a> }
<a href=#235 id=235 data-nosnippet>235</a> PropertyType::ReceiveMaximum =&gt; {
<a href=#236 id=236 data-nosnippet>236</a> receive_max = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#237 id=237 data-nosnippet>237</a> cursor += <span class="number">2</span>;
<a href=#238 id=238 data-nosnippet>238</a> }
<a href=#239 id=239 data-nosnippet>239</a> PropertyType::MaximumQos =&gt; {
<a href=#240 id=240 data-nosnippet>240</a> max_qos = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#241 id=241 data-nosnippet>241</a> cursor += <span class="number">1</span>;
<a href=#242 id=242 data-nosnippet>242</a> }
<a href=#243 id=243 data-nosnippet>243</a> PropertyType::RetainAvailable =&gt; {
<a href=#244 id=244 data-nosnippet>244</a> retain_available = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#245 id=245 data-nosnippet>245</a> cursor += <span class="number">1</span>;
<a href=#246 id=246 data-nosnippet>246</a> }
<a href=#247 id=247 data-nosnippet>247</a> PropertyType::AssignedClientIdentifier =&gt; {
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">let </span>id = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#249 id=249 data-nosnippet>249</a> cursor += <span class="number">2 </span>+ id.len();
<a href=#250 id=250 data-nosnippet>250</a> assigned_client_identifier = <span class="prelude-val">Some</span>(id);
<a href=#251 id=251 data-nosnippet>251</a> }
<a href=#252 id=252 data-nosnippet>252</a> PropertyType::MaximumPacketSize =&gt; {
<a href=#253 id=253 data-nosnippet>253</a> max_packet_size = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#254 id=254 data-nosnippet>254</a> cursor += <span class="number">4</span>;
<a href=#255 id=255 data-nosnippet>255</a> }
<a href=#256 id=256 data-nosnippet>256</a> PropertyType::TopicAliasMaximum =&gt; {
<a href=#257 id=257 data-nosnippet>257</a> topic_alias_max = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#258 id=258 data-nosnippet>258</a> cursor += <span class="number">2</span>;
<a href=#259 id=259 data-nosnippet>259</a> }
<a href=#260 id=260 data-nosnippet>260</a> PropertyType::ReasonString =&gt; {
<a href=#261 id=261 data-nosnippet>261</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#262 id=262 data-nosnippet>262</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#263 id=263 data-nosnippet>263</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#264 id=264 data-nosnippet>264</a> }
<a href=#265 id=265 data-nosnippet>265</a> PropertyType::UserProperty =&gt; {
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#268 id=268 data-nosnippet>268</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#269 id=269 data-nosnippet>269</a> user_properties.push((key, value));
<a href=#270 id=270 data-nosnippet>270</a> }
<a href=#271 id=271 data-nosnippet>271</a> PropertyType::WildcardSubscriptionAvailable =&gt; {
<a href=#272 id=272 data-nosnippet>272</a> wildcard_subscription_available = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#273 id=273 data-nosnippet>273</a> cursor += <span class="number">1</span>;
<a href=#274 id=274 data-nosnippet>274</a> }
<a href=#275 id=275 data-nosnippet>275</a> PropertyType::SubscriptionIdentifierAvailable =&gt; {
<a href=#276 id=276 data-nosnippet>276</a> subscription_identifiers_available = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#277 id=277 data-nosnippet>277</a> cursor += <span class="number">1</span>;
<a href=#278 id=278 data-nosnippet>278</a> }
<a href=#279 id=279 data-nosnippet>279</a> PropertyType::SharedSubscriptionAvailable =&gt; {
<a href=#280 id=280 data-nosnippet>280</a> shared_subscription_available = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#281 id=281 data-nosnippet>281</a> cursor += <span class="number">1</span>;
<a href=#282 id=282 data-nosnippet>282</a> }
<a href=#283 id=283 data-nosnippet>283</a> PropertyType::ServerKeepAlive =&gt; {
<a href=#284 id=284 data-nosnippet>284</a> server_keep_alive = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#285 id=285 data-nosnippet>285</a> cursor += <span class="number">2</span>;
<a href=#286 id=286 data-nosnippet>286</a> }
<a href=#287 id=287 data-nosnippet>287</a> PropertyType::ResponseInformation =&gt; {
<a href=#288 id=288 data-nosnippet>288</a> <span class="kw">let </span>info = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#289 id=289 data-nosnippet>289</a> cursor += <span class="number">2 </span>+ info.len();
<a href=#290 id=290 data-nosnippet>290</a> response_information = <span class="prelude-val">Some</span>(info);
<a href=#291 id=291 data-nosnippet>291</a> }
<a href=#292 id=292 data-nosnippet>292</a> PropertyType::ServerReference =&gt; {
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">let </span>reference = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#294 id=294 data-nosnippet>294</a> cursor += <span class="number">2 </span>+ reference.len();
<a href=#295 id=295 data-nosnippet>295</a> server_reference = <span class="prelude-val">Some</span>(reference);
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a> PropertyType::AuthenticationMethod =&gt; {
<a href=#298 id=298 data-nosnippet>298</a> <span class="kw">let </span>method = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#299 id=299 data-nosnippet>299</a> cursor += <span class="number">2 </span>+ method.len();
<a href=#300 id=300 data-nosnippet>300</a> authentication_method = <span class="prelude-val">Some</span>(method);
<a href=#301 id=301 data-nosnippet>301</a> }
<a href=#302 id=302 data-nosnippet>302</a> PropertyType::AuthenticationData =&gt; {
<a href=#303 id=303 data-nosnippet>303</a> <span class="kw">let </span>data = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#304 id=304 data-nosnippet>304</a> cursor += <span class="number">2 </span>+ data.len();
<a href=#305 id=305 data-nosnippet>305</a> authentication_data = <span class="prelude-val">Some</span>(data);
<a href=#306 id=306 data-nosnippet>306</a> }
<a href=#307 id=307 data-nosnippet>307</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#308 id=308 data-nosnippet>308</a> }
<a href=#309 id=309 data-nosnippet>309</a> }
<a href=#310 id=310 data-nosnippet>310</a>
<a href=#311 id=311 data-nosnippet>311</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(ConnAckProperties {
<a href=#312 id=312 data-nosnippet>312</a> session_expiry_interval,
<a href=#313 id=313 data-nosnippet>313</a> receive_max,
<a href=#314 id=314 data-nosnippet>314</a> max_qos,
<a href=#315 id=315 data-nosnippet>315</a> retain_available,
<a href=#316 id=316 data-nosnippet>316</a> max_packet_size,
<a href=#317 id=317 data-nosnippet>317</a> assigned_client_identifier,
<a href=#318 id=318 data-nosnippet>318</a> topic_alias_max,
<a href=#319 id=319 data-nosnippet>319</a> reason_string,
<a href=#320 id=320 data-nosnippet>320</a> user_properties,
<a href=#321 id=321 data-nosnippet>321</a> wildcard_subscription_available,
<a href=#322 id=322 data-nosnippet>322</a> subscription_identifiers_available,
<a href=#323 id=323 data-nosnippet>323</a> shared_subscription_available,
<a href=#324 id=324 data-nosnippet>324</a> server_keep_alive,
<a href=#325 id=325 data-nosnippet>325</a> response_information,
<a href=#326 id=326 data-nosnippet>326</a> server_reference,
<a href=#327 id=327 data-nosnippet>327</a> authentication_method,
<a href=#328 id=328 data-nosnippet>328</a> authentication_data,
<a href=#329 id=329 data-nosnippet>329</a> }))
<a href=#330 id=330 data-nosnippet>330</a> }
<a href=#331 id=331 data-nosnippet>331</a>
<a href=#332 id=332 data-nosnippet>332</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#333 id=333 data-nosnippet>333</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#334 id=334 data-nosnippet>334</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#335 id=335 data-nosnippet>335</a>
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(session_expiry_interval) = <span class="self">self</span>.session_expiry_interval {
<a href=#337 id=337 data-nosnippet>337</a> buffer.put_u8(PropertyType::SessionExpiryInterval <span class="kw">as </span>u8);
<a href=#338 id=338 data-nosnippet>338</a> buffer.put_u32(session_expiry_interval);
<a href=#339 id=339 data-nosnippet>339</a> }
<a href=#340 id=340 data-nosnippet>340</a>
<a href=#341 id=341 data-nosnippet>341</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(receive_maximum) = <span class="self">self</span>.receive_max {
<a href=#342 id=342 data-nosnippet>342</a> buffer.put_u8(PropertyType::ReceiveMaximum <span class="kw">as </span>u8);
<a href=#343 id=343 data-nosnippet>343</a> buffer.put_u16(receive_maximum);
<a href=#344 id=344 data-nosnippet>344</a> }
<a href=#345 id=345 data-nosnippet>345</a>
<a href=#346 id=346 data-nosnippet>346</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(qos) = <span class="self">self</span>.max_qos {
<a href=#347 id=347 data-nosnippet>347</a> buffer.put_u8(PropertyType::MaximumQos <span class="kw">as </span>u8);
<a href=#348 id=348 data-nosnippet>348</a> buffer.put_u8(qos);
<a href=#349 id=349 data-nosnippet>349</a> }
<a href=#350 id=350 data-nosnippet>350</a>
<a href=#351 id=351 data-nosnippet>351</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(retain_available) = <span class="self">self</span>.retain_available {
<a href=#352 id=352 data-nosnippet>352</a> buffer.put_u8(PropertyType::RetainAvailable <span class="kw">as </span>u8);
<a href=#353 id=353 data-nosnippet>353</a> buffer.put_u8(retain_available);
<a href=#354 id=354 data-nosnippet>354</a> }
<a href=#355 id=355 data-nosnippet>355</a>
<a href=#356 id=356 data-nosnippet>356</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(max_packet_size) = <span class="self">self</span>.max_packet_size {
<a href=#357 id=357 data-nosnippet>357</a> buffer.put_u8(PropertyType::MaximumPacketSize <span class="kw">as </span>u8);
<a href=#358 id=358 data-nosnippet>358</a> buffer.put_u32(max_packet_size);
<a href=#359 id=359 data-nosnippet>359</a> }
<a href=#360 id=360 data-nosnippet>360</a>
<a href=#361 id=361 data-nosnippet>361</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(id) = <span class="kw-2">&amp;</span><span class="self">self</span>.assigned_client_identifier {
<a href=#362 id=362 data-nosnippet>362</a> buffer.put_u8(PropertyType::AssignedClientIdentifier <span class="kw">as </span>u8);
<a href=#363 id=363 data-nosnippet>363</a> write_mqtt_string(buffer, id);
<a href=#364 id=364 data-nosnippet>364</a> }
<a href=#365 id=365 data-nosnippet>365</a>
<a href=#366 id=366 data-nosnippet>366</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic_alias_max) = <span class="self">self</span>.topic_alias_max {
<a href=#367 id=367 data-nosnippet>367</a> buffer.put_u8(PropertyType::TopicAliasMaximum <span class="kw">as </span>u8);
<a href=#368 id=368 data-nosnippet>368</a> buffer.put_u16(topic_alias_max);
<a href=#369 id=369 data-nosnippet>369</a> }
<a href=#370 id=370 data-nosnippet>370</a>
<a href=#371 id=371 data-nosnippet>371</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#372 id=372 data-nosnippet>372</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#373 id=373 data-nosnippet>373</a> write_mqtt_string(buffer, reason);
<a href=#374 id=374 data-nosnippet>374</a> }
<a href=#375 id=375 data-nosnippet>375</a>
<a href=#376 id=376 data-nosnippet>376</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#377 id=377 data-nosnippet>377</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#378 id=378 data-nosnippet>378</a> write_mqtt_string(buffer, key);
<a href=#379 id=379 data-nosnippet>379</a> write_mqtt_string(buffer, value);
<a href=#380 id=380 data-nosnippet>380</a> }
<a href=#381 id=381 data-nosnippet>381</a>
<a href=#382 id=382 data-nosnippet>382</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(w) = <span class="self">self</span>.wildcard_subscription_available {
<a href=#383 id=383 data-nosnippet>383</a> buffer.put_u8(PropertyType::WildcardSubscriptionAvailable <span class="kw">as </span>u8);
<a href=#384 id=384 data-nosnippet>384</a> buffer.put_u8(w);
<a href=#385 id=385 data-nosnippet>385</a> }
<a href=#386 id=386 data-nosnippet>386</a>
<a href=#387 id=387 data-nosnippet>387</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = <span class="self">self</span>.subscription_identifiers_available {
<a href=#388 id=388 data-nosnippet>388</a> buffer.put_u8(PropertyType::SubscriptionIdentifierAvailable <span class="kw">as </span>u8);
<a href=#389 id=389 data-nosnippet>389</a> buffer.put_u8(s);
<a href=#390 id=390 data-nosnippet>390</a> }
<a href=#391 id=391 data-nosnippet>391</a>
<a href=#392 id=392 data-nosnippet>392</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(s) = <span class="self">self</span>.shared_subscription_available {
<a href=#393 id=393 data-nosnippet>393</a> buffer.put_u8(PropertyType::SharedSubscriptionAvailable <span class="kw">as </span>u8);
<a href=#394 id=394 data-nosnippet>394</a> buffer.put_u8(s);
<a href=#395 id=395 data-nosnippet>395</a> }
<a href=#396 id=396 data-nosnippet>396</a>
<a href=#397 id=397 data-nosnippet>397</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(keep_alive) = <span class="self">self</span>.server_keep_alive {
<a href=#398 id=398 data-nosnippet>398</a> buffer.put_u8(PropertyType::ServerKeepAlive <span class="kw">as </span>u8);
<a href=#399 id=399 data-nosnippet>399</a> buffer.put_u16(keep_alive);
<a href=#400 id=400 data-nosnippet>400</a> }
<a href=#401 id=401 data-nosnippet>401</a>
<a href=#402 id=402 data-nosnippet>402</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(info) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_information {
<a href=#403 id=403 data-nosnippet>403</a> buffer.put_u8(PropertyType::ResponseInformation <span class="kw">as </span>u8);
<a href=#404 id=404 data-nosnippet>404</a> write_mqtt_string(buffer, info);
<a href=#405 id=405 data-nosnippet>405</a> }
<a href=#406 id=406 data-nosnippet>406</a>
<a href=#407 id=407 data-nosnippet>407</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reference) = <span class="kw-2">&amp;</span><span class="self">self</span>.server_reference {
<a href=#408 id=408 data-nosnippet>408</a> buffer.put_u8(PropertyType::ServerReference <span class="kw">as </span>u8);
<a href=#409 id=409 data-nosnippet>409</a> write_mqtt_string(buffer, reference);
<a href=#410 id=410 data-nosnippet>410</a> }
<a href=#411 id=411 data-nosnippet>411</a>
<a href=#412 id=412 data-nosnippet>412</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_method) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_method {
<a href=#413 id=413 data-nosnippet>413</a> buffer.put_u8(PropertyType::AuthenticationMethod <span class="kw">as </span>u8);
<a href=#414 id=414 data-nosnippet>414</a> write_mqtt_string(buffer, authentication_method);
<a href=#415 id=415 data-nosnippet>415</a> }
<a href=#416 id=416 data-nosnippet>416</a>
<a href=#417 id=417 data-nosnippet>417</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_data) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_data {
<a href=#418 id=418 data-nosnippet>418</a> buffer.put_u8(PropertyType::AuthenticationData <span class="kw">as </span>u8);
<a href=#419 id=419 data-nosnippet>419</a> write_mqtt_bytes(buffer, authentication_data);
<a href=#420 id=420 data-nosnippet>420</a> }
<a href=#421 id=421 data-nosnippet>421</a>
<a href=#422 id=422 data-nosnippet>422</a> <span class="prelude-val">Ok</span>(())
<a href=#423 id=423 data-nosnippet>423</a> }
<a href=#424 id=424 data-nosnippet>424</a>}
<a href=#425 id=425 data-nosnippet>425</a>
<a href=#426 id=426 data-nosnippet>426</a><span class="doccomment">/// Connection return code type
<a href=#427 id=427 data-nosnippet>427</a></span><span class="kw">fn </span>connect_return(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;ConnectReturnCode, Error&gt; {
<a href=#428 id=428 data-nosnippet>428</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#429 id=429 data-nosnippet>429</a> <span class="number">0 </span>=&gt; ConnectReturnCode::Success,
<a href=#430 id=430 data-nosnippet>430</a> <span class="number">128 </span>=&gt; ConnectReturnCode::UnspecifiedError,
<a href=#431 id=431 data-nosnippet>431</a> <span class="number">129 </span>=&gt; ConnectReturnCode::MalformedPacket,
<a href=#432 id=432 data-nosnippet>432</a> <span class="number">130 </span>=&gt; ConnectReturnCode::ProtocolError,
<a href=#433 id=433 data-nosnippet>433</a> <span class="number">131 </span>=&gt; ConnectReturnCode::ImplementationSpecificError,
<a href=#434 id=434 data-nosnippet>434</a> <span class="number">132 </span>=&gt; ConnectReturnCode::UnsupportedProtocolVersion,
<a href=#435 id=435 data-nosnippet>435</a> <span class="number">133 </span>=&gt; ConnectReturnCode::ClientIdentifierNotValid,
<a href=#436 id=436 data-nosnippet>436</a> <span class="number">134 </span>=&gt; ConnectReturnCode::BadUserNamePassword,
<a href=#437 id=437 data-nosnippet>437</a> <span class="number">135 </span>=&gt; ConnectReturnCode::NotAuthorized,
<a href=#438 id=438 data-nosnippet>438</a> <span class="number">136 </span>=&gt; ConnectReturnCode::ServerUnavailable,
<a href=#439 id=439 data-nosnippet>439</a> <span class="number">137 </span>=&gt; ConnectReturnCode::ServerBusy,
<a href=#440 id=440 data-nosnippet>440</a> <span class="number">138 </span>=&gt; ConnectReturnCode::Banned,
<a href=#441 id=441 data-nosnippet>441</a> <span class="number">140 </span>=&gt; ConnectReturnCode::BadAuthenticationMethod,
<a href=#442 id=442 data-nosnippet>442</a> <span class="number">144 </span>=&gt; ConnectReturnCode::TopicNameInvalid,
<a href=#443 id=443 data-nosnippet>443</a> <span class="number">149 </span>=&gt; ConnectReturnCode::PacketTooLarge,
<a href=#444 id=444 data-nosnippet>444</a> <span class="number">151 </span>=&gt; ConnectReturnCode::QuotaExceeded,
<a href=#445 id=445 data-nosnippet>445</a> <span class="number">153 </span>=&gt; ConnectReturnCode::PayloadFormatInvalid,
<a href=#446 id=446 data-nosnippet>446</a> <span class="number">154 </span>=&gt; ConnectReturnCode::RetainNotSupported,
<a href=#447 id=447 data-nosnippet>447</a> <span class="number">155 </span>=&gt; ConnectReturnCode::QoSNotSupported,
<a href=#448 id=448 data-nosnippet>448</a> <span class="number">156 </span>=&gt; ConnectReturnCode::UseAnotherServer,
<a href=#449 id=449 data-nosnippet>449</a> <span class="number">157 </span>=&gt; ConnectReturnCode::ServerMoved,
<a href=#450 id=450 data-nosnippet>450</a> <span class="number">159 </span>=&gt; ConnectReturnCode::ConnectionRateExceeded,
<a href=#451 id=451 data-nosnippet>451</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<a href=#452 id=452 data-nosnippet>452</a> };
<a href=#453 id=453 data-nosnippet>453</a>
<a href=#454 id=454 data-nosnippet>454</a> <span class="prelude-val">Ok</span>(code)
<a href=#455 id=455 data-nosnippet>455</a>}
<a href=#456 id=456 data-nosnippet>456</a>
<a href=#457 id=457 data-nosnippet>457</a><span class="kw">fn </span>connect_code(return_code: ConnectReturnCode) -&gt; u8 {
<a href=#458 id=458 data-nosnippet>458</a> <span class="kw">match </span>return_code {
<a href=#459 id=459 data-nosnippet>459</a> ConnectReturnCode::Success =&gt; <span class="number">0</span>,
<a href=#460 id=460 data-nosnippet>460</a> ConnectReturnCode::UnspecifiedError =&gt; <span class="number">128</span>,
<a href=#461 id=461 data-nosnippet>461</a> ConnectReturnCode::MalformedPacket =&gt; <span class="number">129</span>,
<a href=#462 id=462 data-nosnippet>462</a> ConnectReturnCode::ProtocolError =&gt; <span class="number">130</span>,
<a href=#463 id=463 data-nosnippet>463</a> ConnectReturnCode::ImplementationSpecificError =&gt; <span class="number">131</span>,
<a href=#464 id=464 data-nosnippet>464</a> ConnectReturnCode::UnsupportedProtocolVersion =&gt; <span class="number">132</span>,
<a href=#465 id=465 data-nosnippet>465</a> ConnectReturnCode::ClientIdentifierNotValid =&gt; <span class="number">133</span>,
<a href=#466 id=466 data-nosnippet>466</a> ConnectReturnCode::BadUserNamePassword =&gt; <span class="number">134</span>,
<a href=#467 id=467 data-nosnippet>467</a> ConnectReturnCode::NotAuthorized =&gt; <span class="number">135</span>,
<a href=#468 id=468 data-nosnippet>468</a> ConnectReturnCode::ServerUnavailable =&gt; <span class="number">136</span>,
<a href=#469 id=469 data-nosnippet>469</a> ConnectReturnCode::ServerBusy =&gt; <span class="number">137</span>,
<a href=#470 id=470 data-nosnippet>470</a> ConnectReturnCode::Banned =&gt; <span class="number">138</span>,
<a href=#471 id=471 data-nosnippet>471</a> ConnectReturnCode::BadAuthenticationMethod =&gt; <span class="number">140</span>,
<a href=#472 id=472 data-nosnippet>472</a> ConnectReturnCode::TopicNameInvalid =&gt; <span class="number">144</span>,
<a href=#473 id=473 data-nosnippet>473</a> ConnectReturnCode::PacketTooLarge =&gt; <span class="number">149</span>,
<a href=#474 id=474 data-nosnippet>474</a> ConnectReturnCode::QuotaExceeded =&gt; <span class="number">151</span>,
<a href=#475 id=475 data-nosnippet>475</a> ConnectReturnCode::PayloadFormatInvalid =&gt; <span class="number">153</span>,
<a href=#476 id=476 data-nosnippet>476</a> ConnectReturnCode::RetainNotSupported =&gt; <span class="number">154</span>,
<a href=#477 id=477 data-nosnippet>477</a> ConnectReturnCode::QoSNotSupported =&gt; <span class="number">155</span>,
<a href=#478 id=478 data-nosnippet>478</a> ConnectReturnCode::UseAnotherServer =&gt; <span class="number">156</span>,
<a href=#479 id=479 data-nosnippet>479</a> ConnectReturnCode::ServerMoved =&gt; <span class="number">157</span>,
<a href=#480 id=480 data-nosnippet>480</a> ConnectReturnCode::ConnectionRateExceeded =&gt; <span class="number">159</span>,
<a href=#481 id=481 data-nosnippet>481</a> <span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
<a href=#482 id=482 data-nosnippet>482</a> }
<a href=#483 id=483 data-nosnippet>483</a>}
<a href=#484 id=484 data-nosnippet>484</a>
<a href=#485 id=485 data-nosnippet>485</a><span class="attr">#[cfg(test)]
<a href=#486 id=486 data-nosnippet>486</a></span><span class="kw">mod </span>test {
<a href=#487 id=487 data-nosnippet>487</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#488 id=488 data-nosnippet>488</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#489 id=489 data-nosnippet>489</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#490 id=490 data-nosnippet>490</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#491 id=491 data-nosnippet>491</a>
<a href=#492 id=492 data-nosnippet>492</a> <span class="attr">#[test]
<a href=#493 id=493 data-nosnippet>493</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#494 id=494 data-nosnippet>494</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#495 id=495 data-nosnippet>495</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#496 id=496 data-nosnippet>496</a> // remaining_length field in the packet be 2 bytes long.
<a href=#497 id=497 data-nosnippet>497</a> </span><span class="kw">let </span>connack_props = ConnAckProperties {
<a href=#498 id=498 data-nosnippet>498</a> session_expiry_interval: <span class="prelude-val">None</span>,
<a href=#499 id=499 data-nosnippet>499</a> receive_max: <span class="prelude-val">None</span>,
<a href=#500 id=500 data-nosnippet>500</a> max_qos: <span class="prelude-val">None</span>,
<a href=#501 id=501 data-nosnippet>501</a> retain_available: <span class="prelude-val">None</span>,
<a href=#502 id=502 data-nosnippet>502</a> max_packet_size: <span class="prelude-val">None</span>,
<a href=#503 id=503 data-nosnippet>503</a> assigned_client_identifier: <span class="prelude-val">None</span>,
<a href=#504 id=504 data-nosnippet>504</a> topic_alias_max: <span class="prelude-val">None</span>,
<a href=#505 id=505 data-nosnippet>505</a> reason_string: <span class="prelude-val">None</span>,
<a href=#506 id=506 data-nosnippet>506</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#507 id=507 data-nosnippet>507</a> wildcard_subscription_available: <span class="prelude-val">None</span>,
<a href=#508 id=508 data-nosnippet>508</a> subscription_identifiers_available: <span class="prelude-val">None</span>,
<a href=#509 id=509 data-nosnippet>509</a> shared_subscription_available: <span class="prelude-val">None</span>,
<a href=#510 id=510 data-nosnippet>510</a> server_keep_alive: <span class="prelude-val">None</span>,
<a href=#511 id=511 data-nosnippet>511</a> response_information: <span class="prelude-val">None</span>,
<a href=#512 id=512 data-nosnippet>512</a> server_reference: <span class="prelude-val">None</span>,
<a href=#513 id=513 data-nosnippet>513</a> authentication_method: <span class="prelude-val">None</span>,
<a href=#514 id=514 data-nosnippet>514</a> authentication_data: <span class="prelude-val">None</span>,
<a href=#515 id=515 data-nosnippet>515</a> };
<a href=#516 id=516 data-nosnippet>516</a>
<a href=#517 id=517 data-nosnippet>517</a> <span class="kw">let </span>connack_pkt = ConnAck {
<a href=#518 id=518 data-nosnippet>518</a> session_present: <span class="bool-val">false</span>,
<a href=#519 id=519 data-nosnippet>519</a> code: ConnectReturnCode::Success,
<a href=#520 id=520 data-nosnippet>520</a> properties: <span class="prelude-val">Some</span>(connack_props),
<a href=#521 id=521 data-nosnippet>521</a> };
<a href=#522 id=522 data-nosnippet>522</a>
<a href=#523 id=523 data-nosnippet>523</a> <span class="kw">let </span>size_from_size = connack_pkt.size();
<a href=#524 id=524 data-nosnippet>524</a> <span class="kw">let </span>size_from_write = connack_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#525 id=525 data-nosnippet>525</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#526 id=526 data-nosnippet>526</a>
<a href=#527 id=527 data-nosnippet>527</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#528 id=528 data-nosnippet>528</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#529 id=529 data-nosnippet>529</a> }
<a href=#530 id=530 data-nosnippet>530</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,687 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/connect.rs`."><title>connect.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>connect.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, Bytes};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Connection packet initiated by the client
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>Connect {
<a href=#7 id=7 data-nosnippet>7</a> <span class="doccomment">/// Mqtt keep alive time
<a href=#8 id=8 data-nosnippet>8</a> </span><span class="kw">pub </span>keep_alive: u16,
<a href=#9 id=9 data-nosnippet>9</a> <span class="doccomment">/// Client Id
<a href=#10 id=10 data-nosnippet>10</a> </span><span class="kw">pub </span>client_id: String,
<a href=#11 id=11 data-nosnippet>11</a> <span class="doccomment">/// Clean session. Asks the broker to clear previous state
<a href=#12 id=12 data-nosnippet>12</a> </span><span class="kw">pub </span>clean_start: bool,
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;ConnectProperties&gt;,
<a href=#14 id=14 data-nosnippet>14</a>}
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">impl </span>Connect {
<a href=#17 id=17 data-nosnippet>17</a> <span class="attr">#[allow(clippy::type_complexity)]
<a href=#18 id=18 data-nosnippet>18</a> </span><span class="kw">pub fn </span>read(
<a href=#19 id=19 data-nosnippet>19</a> fixed_header: FixedHeader,
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw-2">mut </span>bytes: Bytes,
<a href=#21 id=21 data-nosnippet>21</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;(Connect, <span class="prelude-ty">Option</span>&lt;LastWill&gt;, <span class="prelude-ty">Option</span>&lt;Login&gt;), Error&gt; {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#23 id=23 data-nosnippet>23</a> bytes.advance(variable_header_index);
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> <span class="comment">// Variable header
<a href=#26 id=26 data-nosnippet>26</a> </span><span class="kw">let </span>protocol_name = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>protocol_level = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">if </span>protocol_name != <span class="string">"MQTT" </span>{
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidProtocol);
<a href=#30 id=30 data-nosnippet>30</a> }
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">if </span>protocol_level != <span class="number">5 </span>{
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidProtocolLevel(protocol_level));
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span>connect_flags = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span>clean_start = (connect_flags &amp; <span class="number">0b10</span>) != <span class="number">0</span>;
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>keep_alive = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>properties = ConnectProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">let </span>client_id = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>will = LastWill::read(connect_flags, <span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>login = Login::read(connect_flags, <span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>connect = Connect {
<a href=#47 id=47 data-nosnippet>47</a> keep_alive,
<a href=#48 id=48 data-nosnippet>48</a> client_id,
<a href=#49 id=49 data-nosnippet>49</a> clean_start,
<a href=#50 id=50 data-nosnippet>50</a> properties,
<a href=#51 id=51 data-nosnippet>51</a> };
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a> <span class="prelude-val">Ok</span>((connect, will, login))
<a href=#54 id=54 data-nosnippet>54</a> }
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>, will: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;LastWill&gt;, l: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;Login&gt;) -&gt; usize {
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="string">"MQTT"</span>.len() <span class="comment">// protocol name
<a href=#58 id=58 data-nosnippet>58</a> </span>+ <span class="number">1 </span><span class="comment">// protocol version
<a href=#59 id=59 data-nosnippet>59</a> </span>+ <span class="number">1 </span><span class="comment">// connect flags
<a href=#60 id=60 data-nosnippet>60</a> </span>+ <span class="number">2</span>; <span class="comment">// keep alive
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>properties_len = p.len();
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#65 id=65 data-nosnippet>65</a> len += properties_len_len + properties_len;
<a href=#66 id=66 data-nosnippet>66</a> } <span class="kw">else </span>{
<a href=#67 id=67 data-nosnippet>67</a> <span class="comment">// just 1 byte representing 0 len
<a href=#68 id=68 data-nosnippet>68</a> </span>len += <span class="number">1</span>;
<a href=#69 id=69 data-nosnippet>69</a> }
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> len += <span class="number">2 </span>+ <span class="self">self</span>.client_id.len();
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="comment">// last will len
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(w) = will {
<a href=#75 id=75 data-nosnippet>75</a> len += w.len();
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="comment">// username and password len
<a href=#79 id=79 data-nosnippet>79</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(l) = l {
<a href=#80 id=80 data-nosnippet>80</a> len += l.len();
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a> len
<a href=#84 id=84 data-nosnippet>84</a> }
<a href=#85 id=85 data-nosnippet>85</a>
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">pub fn </span>write(
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw-2">&amp;</span><span class="self">self</span>,
<a href=#88 id=88 data-nosnippet>88</a> will: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;LastWill&gt;,
<a href=#89 id=89 data-nosnippet>89</a> l: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;Login&gt;,
<a href=#90 id=90 data-nosnippet>90</a> buffer: <span class="kw-2">&amp;mut </span>BytesMut,
<a href=#91 id=91 data-nosnippet>91</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">let </span>len = <span class="self">self</span>.len(will, l);
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a> buffer.put_u8(<span class="number">0b0001_0000</span>);
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#96 id=96 data-nosnippet>96</a> write_mqtt_string(buffer, <span class="string">"MQTT"</span>);
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a> buffer.put_u8(<span class="number">0x05</span>);
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">let </span>flags_index = <span class="number">1 </span>+ count + <span class="number">2 </span>+ <span class="number">4 </span>+ <span class="number">1</span>;
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if </span><span class="self">self</span>.clean_start {
<a href=#103 id=103 data-nosnippet>103</a> connect_flags |= <span class="number">0x02</span>;
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> buffer.put_u8(connect_flags);
<a href=#107 id=107 data-nosnippet>107</a> buffer.put_u16(<span class="self">self</span>.keep_alive);
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#110 id=110 data-nosnippet>110</a> <span class="prelude-val">Some</span>(p) =&gt; p.write(buffer)<span class="question-mark">?</span>,
<a href=#111 id=111 data-nosnippet>111</a> <span class="prelude-val">None </span>=&gt; {
<a href=#112 id=112 data-nosnippet>112</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#113 id=113 data-nosnippet>113</a> }
<a href=#114 id=114 data-nosnippet>114</a> };
<a href=#115 id=115 data-nosnippet>115</a>
<a href=#116 id=116 data-nosnippet>116</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.client_id);
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(w) = will {
<a href=#119 id=119 data-nosnippet>119</a> connect_flags |= w.write(buffer)<span class="question-mark">?</span>;
<a href=#120 id=120 data-nosnippet>120</a> }
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(l) = l {
<a href=#123 id=123 data-nosnippet>123</a> connect_flags |= l.write(buffer);
<a href=#124 id=124 data-nosnippet>124</a> }
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a> <span class="comment">// update connect flags
<a href=#127 id=127 data-nosnippet>127</a> </span>buffer[flags_index] = connect_flags;
<a href=#128 id=128 data-nosnippet>128</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a>}
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#133 id=133 data-nosnippet>133</a></span><span class="kw">pub struct </span>ConnectProperties {
<a href=#134 id=134 data-nosnippet>134</a> <span class="doccomment">/// Expiry interval property after loosing connection
<a href=#135 id=135 data-nosnippet>135</a> </span><span class="kw">pub </span>session_expiry_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// Maximum simultaneous packets
<a href=#137 id=137 data-nosnippet>137</a> </span><span class="kw">pub </span>receive_maximum: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#138 id=138 data-nosnippet>138</a> <span class="doccomment">/// Maximum packet size
<a href=#139 id=139 data-nosnippet>139</a> </span><span class="kw">pub </span>max_packet_size: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#140 id=140 data-nosnippet>140</a> <span class="doccomment">/// Maximum mapping integer for a topic
<a href=#141 id=141 data-nosnippet>141</a> </span><span class="kw">pub </span>topic_alias_max: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">pub </span>request_response_info: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">pub </span>request_problem_info: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#144 id=144 data-nosnippet>144</a> <span class="doccomment">/// List of user properties
<a href=#145 id=145 data-nosnippet>145</a> </span><span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#146 id=146 data-nosnippet>146</a> <span class="doccomment">/// Method of authentication
<a href=#147 id=147 data-nosnippet>147</a> </span><span class="kw">pub </span>authentication_method: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#148 id=148 data-nosnippet>148</a> <span class="doccomment">/// Authentication data
<a href=#149 id=149 data-nosnippet>149</a> </span><span class="kw">pub </span>authentication_data: <span class="prelude-ty">Option</span>&lt;Bytes&gt;,
<a href=#150 id=150 data-nosnippet>150</a>}
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a><span class="kw">impl </span>ConnectProperties {
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">pub fn </span>new() -&gt; ConnectProperties {
<a href=#154 id=154 data-nosnippet>154</a> ConnectProperties {
<a href=#155 id=155 data-nosnippet>155</a> session_expiry_interval: <span class="prelude-val">None</span>,
<a href=#156 id=156 data-nosnippet>156</a> receive_maximum: <span class="prelude-val">None</span>,
<a href=#157 id=157 data-nosnippet>157</a> max_packet_size: <span class="prelude-val">None</span>,
<a href=#158 id=158 data-nosnippet>158</a> topic_alias_max: <span class="prelude-val">None</span>,
<a href=#159 id=159 data-nosnippet>159</a> request_response_info: <span class="prelude-val">None</span>,
<a href=#160 id=160 data-nosnippet>160</a> request_problem_info: <span class="prelude-val">None</span>,
<a href=#161 id=161 data-nosnippet>161</a> user_properties: Vec::new(),
<a href=#162 id=162 data-nosnippet>162</a> authentication_method: <span class="prelude-val">None</span>,
<a href=#163 id=163 data-nosnippet>163</a> authentication_data: <span class="prelude-val">None</span>,
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a> }
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;ConnectProperties&gt;, Error&gt; {
<a href=#168 id=168 data-nosnippet>168</a> <span class="kw">let </span><span class="kw-2">mut </span>session_expiry_interval = <span class="prelude-val">None</span>;
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">let </span><span class="kw-2">mut </span>receive_maximum = <span class="prelude-val">None</span>;
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span><span class="kw-2">mut </span>max_packet_size = <span class="prelude-val">None</span>;
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">let </span><span class="kw-2">mut </span>topic_alias_max = <span class="prelude-val">None</span>;
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">let </span><span class="kw-2">mut </span>request_response_info = <span class="prelude-val">None</span>;
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw">let </span><span class="kw-2">mut </span>request_problem_info = <span class="prelude-val">None</span>;
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span><span class="kw-2">mut </span>authentication_method = <span class="prelude-val">None</span>;
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">let </span><span class="kw-2">mut </span>authentication_data = <span class="prelude-val">None</span>;
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#179 id=179 data-nosnippet>179</a> bytes.advance(properties_len_len);
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#185 id=185 data-nosnippet>185</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#186 id=186 data-nosnippet>186</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#187 id=187 data-nosnippet>187</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#188 id=188 data-nosnippet>188</a> cursor += <span class="number">1</span>;
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#190 id=190 data-nosnippet>190</a> PropertyType::SessionExpiryInterval =&gt; {
<a href=#191 id=191 data-nosnippet>191</a> session_expiry_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#192 id=192 data-nosnippet>192</a> cursor += <span class="number">4</span>;
<a href=#193 id=193 data-nosnippet>193</a> }
<a href=#194 id=194 data-nosnippet>194</a> PropertyType::ReceiveMaximum =&gt; {
<a href=#195 id=195 data-nosnippet>195</a> receive_maximum = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#196 id=196 data-nosnippet>196</a> cursor += <span class="number">2</span>;
<a href=#197 id=197 data-nosnippet>197</a> }
<a href=#198 id=198 data-nosnippet>198</a> PropertyType::MaximumPacketSize =&gt; {
<a href=#199 id=199 data-nosnippet>199</a> max_packet_size = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#200 id=200 data-nosnippet>200</a> cursor += <span class="number">4</span>;
<a href=#201 id=201 data-nosnippet>201</a> }
<a href=#202 id=202 data-nosnippet>202</a> PropertyType::TopicAliasMaximum =&gt; {
<a href=#203 id=203 data-nosnippet>203</a> topic_alias_max = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#204 id=204 data-nosnippet>204</a> cursor += <span class="number">2</span>;
<a href=#205 id=205 data-nosnippet>205</a> }
<a href=#206 id=206 data-nosnippet>206</a> PropertyType::RequestResponseInformation =&gt; {
<a href=#207 id=207 data-nosnippet>207</a> request_response_info = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#208 id=208 data-nosnippet>208</a> cursor += <span class="number">1</span>;
<a href=#209 id=209 data-nosnippet>209</a> }
<a href=#210 id=210 data-nosnippet>210</a> PropertyType::RequestProblemInformation =&gt; {
<a href=#211 id=211 data-nosnippet>211</a> request_problem_info = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#212 id=212 data-nosnippet>212</a> cursor += <span class="number">1</span>;
<a href=#213 id=213 data-nosnippet>213</a> }
<a href=#214 id=214 data-nosnippet>214</a> PropertyType::UserProperty =&gt; {
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#217 id=217 data-nosnippet>217</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#218 id=218 data-nosnippet>218</a> user_properties.push((key, value));
<a href=#219 id=219 data-nosnippet>219</a> }
<a href=#220 id=220 data-nosnippet>220</a> PropertyType::AuthenticationMethod =&gt; {
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">let </span>method = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#222 id=222 data-nosnippet>222</a> cursor += <span class="number">2 </span>+ method.len();
<a href=#223 id=223 data-nosnippet>223</a> authentication_method = <span class="prelude-val">Some</span>(method);
<a href=#224 id=224 data-nosnippet>224</a> }
<a href=#225 id=225 data-nosnippet>225</a> PropertyType::AuthenticationData =&gt; {
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">let </span>data = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#227 id=227 data-nosnippet>227</a> cursor += <span class="number">2 </span>+ data.len();
<a href=#228 id=228 data-nosnippet>228</a> authentication_data = <span class="prelude-val">Some</span>(data);
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#231 id=231 data-nosnippet>231</a> }
<a href=#232 id=232 data-nosnippet>232</a> }
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(ConnectProperties {
<a href=#235 id=235 data-nosnippet>235</a> session_expiry_interval,
<a href=#236 id=236 data-nosnippet>236</a> receive_maximum,
<a href=#237 id=237 data-nosnippet>237</a> max_packet_size,
<a href=#238 id=238 data-nosnippet>238</a> topic_alias_max,
<a href=#239 id=239 data-nosnippet>239</a> request_response_info,
<a href=#240 id=240 data-nosnippet>240</a> request_problem_info,
<a href=#241 id=241 data-nosnippet>241</a> user_properties,
<a href=#242 id=242 data-nosnippet>242</a> authentication_method,
<a href=#243 id=243 data-nosnippet>243</a> authentication_data,
<a href=#244 id=244 data-nosnippet>244</a> }))
<a href=#245 id=245 data-nosnippet>245</a> }
<a href=#246 id=246 data-nosnippet>246</a>
<a href=#247 id=247 data-nosnippet>247</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#249 id=249 data-nosnippet>249</a>
<a href=#250 id=250 data-nosnippet>250</a> <span class="kw">if </span><span class="self">self</span>.session_expiry_interval.is_some() {
<a href=#251 id=251 data-nosnippet>251</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#252 id=252 data-nosnippet>252</a> }
<a href=#253 id=253 data-nosnippet>253</a>
<a href=#254 id=254 data-nosnippet>254</a> <span class="kw">if </span><span class="self">self</span>.receive_maximum.is_some() {
<a href=#255 id=255 data-nosnippet>255</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#256 id=256 data-nosnippet>256</a> }
<a href=#257 id=257 data-nosnippet>257</a>
<a href=#258 id=258 data-nosnippet>258</a> <span class="kw">if </span><span class="self">self</span>.max_packet_size.is_some() {
<a href=#259 id=259 data-nosnippet>259</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#260 id=260 data-nosnippet>260</a> }
<a href=#261 id=261 data-nosnippet>261</a>
<a href=#262 id=262 data-nosnippet>262</a> <span class="kw">if </span><span class="self">self</span>.topic_alias_max.is_some() {
<a href=#263 id=263 data-nosnippet>263</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#264 id=264 data-nosnippet>264</a> }
<a href=#265 id=265 data-nosnippet>265</a>
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">if </span><span class="self">self</span>.request_response_info.is_some() {
<a href=#267 id=267 data-nosnippet>267</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#268 id=268 data-nosnippet>268</a> }
<a href=#269 id=269 data-nosnippet>269</a>
<a href=#270 id=270 data-nosnippet>270</a> <span class="kw">if </span><span class="self">self</span>.request_problem_info.is_some() {
<a href=#271 id=271 data-nosnippet>271</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#272 id=272 data-nosnippet>272</a> }
<a href=#273 id=273 data-nosnippet>273</a>
<a href=#274 id=274 data-nosnippet>274</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#275 id=275 data-nosnippet>275</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#276 id=276 data-nosnippet>276</a> }
<a href=#277 id=277 data-nosnippet>277</a>
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_method) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_method {
<a href=#279 id=279 data-nosnippet>279</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ authentication_method.len();
<a href=#280 id=280 data-nosnippet>280</a> }
<a href=#281 id=281 data-nosnippet>281</a>
<a href=#282 id=282 data-nosnippet>282</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_data) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_data {
<a href=#283 id=283 data-nosnippet>283</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ authentication_data.len();
<a href=#284 id=284 data-nosnippet>284</a> }
<a href=#285 id=285 data-nosnippet>285</a>
<a href=#286 id=286 data-nosnippet>286</a> len
<a href=#287 id=287 data-nosnippet>287</a> }
<a href=#288 id=288 data-nosnippet>288</a>
<a href=#289 id=289 data-nosnippet>289</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#291 id=291 data-nosnippet>291</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#292 id=292 data-nosnippet>292</a>
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(session_expiry_interval) = <span class="self">self</span>.session_expiry_interval {
<a href=#294 id=294 data-nosnippet>294</a> buffer.put_u8(PropertyType::SessionExpiryInterval <span class="kw">as </span>u8);
<a href=#295 id=295 data-nosnippet>295</a> buffer.put_u32(session_expiry_interval);
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a>
<a href=#298 id=298 data-nosnippet>298</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(receive_maximum) = <span class="self">self</span>.receive_maximum {
<a href=#299 id=299 data-nosnippet>299</a> buffer.put_u8(PropertyType::ReceiveMaximum <span class="kw">as </span>u8);
<a href=#300 id=300 data-nosnippet>300</a> buffer.put_u16(receive_maximum);
<a href=#301 id=301 data-nosnippet>301</a> }
<a href=#302 id=302 data-nosnippet>302</a>
<a href=#303 id=303 data-nosnippet>303</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(max_packet_size) = <span class="self">self</span>.max_packet_size {
<a href=#304 id=304 data-nosnippet>304</a> buffer.put_u8(PropertyType::MaximumPacketSize <span class="kw">as </span>u8);
<a href=#305 id=305 data-nosnippet>305</a> buffer.put_u32(max_packet_size);
<a href=#306 id=306 data-nosnippet>306</a> }
<a href=#307 id=307 data-nosnippet>307</a>
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic_alias_max) = <span class="self">self</span>.topic_alias_max {
<a href=#309 id=309 data-nosnippet>309</a> buffer.put_u8(PropertyType::TopicAliasMaximum <span class="kw">as </span>u8);
<a href=#310 id=310 data-nosnippet>310</a> buffer.put_u16(topic_alias_max);
<a href=#311 id=311 data-nosnippet>311</a> }
<a href=#312 id=312 data-nosnippet>312</a>
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(request_response_info) = <span class="self">self</span>.request_response_info {
<a href=#314 id=314 data-nosnippet>314</a> buffer.put_u8(PropertyType::RequestResponseInformation <span class="kw">as </span>u8);
<a href=#315 id=315 data-nosnippet>315</a> buffer.put_u8(request_response_info);
<a href=#316 id=316 data-nosnippet>316</a> }
<a href=#317 id=317 data-nosnippet>317</a>
<a href=#318 id=318 data-nosnippet>318</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(request_problem_info) = <span class="self">self</span>.request_problem_info {
<a href=#319 id=319 data-nosnippet>319</a> buffer.put_u8(PropertyType::RequestProblemInformation <span class="kw">as </span>u8);
<a href=#320 id=320 data-nosnippet>320</a> buffer.put_u8(request_problem_info);
<a href=#321 id=321 data-nosnippet>321</a> }
<a href=#322 id=322 data-nosnippet>322</a>
<a href=#323 id=323 data-nosnippet>323</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#324 id=324 data-nosnippet>324</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#325 id=325 data-nosnippet>325</a> write_mqtt_string(buffer, key);
<a href=#326 id=326 data-nosnippet>326</a> write_mqtt_string(buffer, value);
<a href=#327 id=327 data-nosnippet>327</a> }
<a href=#328 id=328 data-nosnippet>328</a>
<a href=#329 id=329 data-nosnippet>329</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_method) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_method {
<a href=#330 id=330 data-nosnippet>330</a> buffer.put_u8(PropertyType::AuthenticationMethod <span class="kw">as </span>u8);
<a href=#331 id=331 data-nosnippet>331</a> write_mqtt_string(buffer, authentication_method);
<a href=#332 id=332 data-nosnippet>332</a> }
<a href=#333 id=333 data-nosnippet>333</a>
<a href=#334 id=334 data-nosnippet>334</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(authentication_data) = <span class="kw-2">&amp;</span><span class="self">self</span>.authentication_data {
<a href=#335 id=335 data-nosnippet>335</a> buffer.put_u8(PropertyType::AuthenticationData <span class="kw">as </span>u8);
<a href=#336 id=336 data-nosnippet>336</a> write_mqtt_bytes(buffer, authentication_data);
<a href=#337 id=337 data-nosnippet>337</a> }
<a href=#338 id=338 data-nosnippet>338</a>
<a href=#339 id=339 data-nosnippet>339</a> <span class="prelude-val">Ok</span>(())
<a href=#340 id=340 data-nosnippet>340</a> }
<a href=#341 id=341 data-nosnippet>341</a>}
<a href=#342 id=342 data-nosnippet>342</a>
<a href=#343 id=343 data-nosnippet>343</a><span class="kw">impl </span>Default <span class="kw">for </span>ConnectProperties {
<a href=#344 id=344 data-nosnippet>344</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#345 id=345 data-nosnippet>345</a> <span class="self">Self</span>::new()
<a href=#346 id=346 data-nosnippet>346</a> }
<a href=#347 id=347 data-nosnippet>347</a>}
<a href=#348 id=348 data-nosnippet>348</a>
<a href=#349 id=349 data-nosnippet>349</a><span class="doccomment">/// LastWill that broker forwards on behalf of the client
<a href=#350 id=350 data-nosnippet>350</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#351 id=351 data-nosnippet>351</a></span><span class="kw">pub struct </span>LastWill {
<a href=#352 id=352 data-nosnippet>352</a> <span class="kw">pub </span>topic: Bytes,
<a href=#353 id=353 data-nosnippet>353</a> <span class="kw">pub </span>message: Bytes,
<a href=#354 id=354 data-nosnippet>354</a> <span class="kw">pub </span>qos: QoS,
<a href=#355 id=355 data-nosnippet>355</a> <span class="kw">pub </span>retain: bool,
<a href=#356 id=356 data-nosnippet>356</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;LastWillProperties&gt;,
<a href=#357 id=357 data-nosnippet>357</a>}
<a href=#358 id=358 data-nosnippet>358</a>
<a href=#359 id=359 data-nosnippet>359</a><span class="kw">impl </span>LastWill {
<a href=#360 id=360 data-nosnippet>360</a> <span class="kw">pub fn </span>new(
<a href=#361 id=361 data-nosnippet>361</a> topic: <span class="kw">impl </span>Into&lt;String&gt;,
<a href=#362 id=362 data-nosnippet>362</a> payload: <span class="kw">impl </span>Into&lt;Vec&lt;u8&gt;&gt;,
<a href=#363 id=363 data-nosnippet>363</a> qos: QoS,
<a href=#364 id=364 data-nosnippet>364</a> retain: bool,
<a href=#365 id=365 data-nosnippet>365</a> properties: <span class="prelude-ty">Option</span>&lt;LastWillProperties&gt;,
<a href=#366 id=366 data-nosnippet>366</a> ) -&gt; LastWill {
<a href=#367 id=367 data-nosnippet>367</a> <span class="kw">let </span>topic = Bytes::copy_from_slice(topic.into().as_bytes());
<a href=#368 id=368 data-nosnippet>368</a> LastWill {
<a href=#369 id=369 data-nosnippet>369</a> topic,
<a href=#370 id=370 data-nosnippet>370</a> message: Bytes::from(payload.into()),
<a href=#371 id=371 data-nosnippet>371</a> qos,
<a href=#372 id=372 data-nosnippet>372</a> retain,
<a href=#373 id=373 data-nosnippet>373</a> properties,
<a href=#374 id=374 data-nosnippet>374</a> }
<a href=#375 id=375 data-nosnippet>375</a> }
<a href=#376 id=376 data-nosnippet>376</a>
<a href=#377 id=377 data-nosnippet>377</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#378 id=378 data-nosnippet>378</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#379 id=379 data-nosnippet>379</a>
<a href=#380 id=380 data-nosnippet>380</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#381 id=381 data-nosnippet>381</a> <span class="kw">let </span>properties_len = p.len();
<a href=#382 id=382 data-nosnippet>382</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#383 id=383 data-nosnippet>383</a> len += properties_len_len + properties_len;
<a href=#384 id=384 data-nosnippet>384</a> } <span class="kw">else </span>{
<a href=#385 id=385 data-nosnippet>385</a> <span class="comment">// just 1 byte representing 0 len
<a href=#386 id=386 data-nosnippet>386</a> </span>len += <span class="number">1</span>;
<a href=#387 id=387 data-nosnippet>387</a> }
<a href=#388 id=388 data-nosnippet>388</a>
<a href=#389 id=389 data-nosnippet>389</a> len += <span class="number">2 </span>+ <span class="self">self</span>.topic.len() + <span class="number">2 </span>+ <span class="self">self</span>.message.len();
<a href=#390 id=390 data-nosnippet>390</a> len
<a href=#391 id=391 data-nosnippet>391</a> }
<a href=#392 id=392 data-nosnippet>392</a>
<a href=#393 id=393 data-nosnippet>393</a> <span class="kw">pub fn </span>read(connect_flags: u8, bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;LastWill&gt;, Error&gt; {
<a href=#394 id=394 data-nosnippet>394</a> <span class="kw">let </span>o = <span class="kw">match </span>connect_flags &amp; <span class="number">0b100 </span>{
<a href=#395 id=395 data-nosnippet>395</a> <span class="number">0 </span><span class="kw">if </span>(connect_flags &amp; <span class="number">0b0011_1000</span>) != <span class="number">0 </span>=&gt; {
<a href=#396 id=396 data-nosnippet>396</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::IncorrectPacketFormat);
<a href=#397 id=397 data-nosnippet>397</a> }
<a href=#398 id=398 data-nosnippet>398</a> <span class="number">0 </span>=&gt; <span class="prelude-val">None</span>,
<a href=#399 id=399 data-nosnippet>399</a> <span class="kw">_ </span>=&gt; {
<a href=#400 id=400 data-nosnippet>400</a> <span class="comment">// Properties in variable header
<a href=#401 id=401 data-nosnippet>401</a> </span><span class="kw">let </span>properties = LastWillProperties::read(bytes)<span class="question-mark">?</span>;
<a href=#402 id=402 data-nosnippet>402</a>
<a href=#403 id=403 data-nosnippet>403</a> <span class="kw">let </span>will_topic = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#404 id=404 data-nosnippet>404</a> <span class="kw">let </span>will_message = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#405 id=405 data-nosnippet>405</a> <span class="kw">let </span>qos_num = (connect_flags &amp; <span class="number">0b11000</span>) &gt;&gt; <span class="number">3</span>;
<a href=#406 id=406 data-nosnippet>406</a> <span class="kw">let </span>will_qos = qos(qos_num).ok_or(Error::InvalidQoS(qos_num))<span class="question-mark">?</span>;
<a href=#407 id=407 data-nosnippet>407</a> <span class="prelude-val">Some</span>(LastWill {
<a href=#408 id=408 data-nosnippet>408</a> topic: will_topic,
<a href=#409 id=409 data-nosnippet>409</a> message: will_message,
<a href=#410 id=410 data-nosnippet>410</a> qos: will_qos,
<a href=#411 id=411 data-nosnippet>411</a> retain: (connect_flags &amp; <span class="number">0b0010_0000</span>) != <span class="number">0</span>,
<a href=#412 id=412 data-nosnippet>412</a> properties,
<a href=#413 id=413 data-nosnippet>413</a> })
<a href=#414 id=414 data-nosnippet>414</a> }
<a href=#415 id=415 data-nosnippet>415</a> };
<a href=#416 id=416 data-nosnippet>416</a>
<a href=#417 id=417 data-nosnippet>417</a> <span class="prelude-val">Ok</span>(o)
<a href=#418 id=418 data-nosnippet>418</a> }
<a href=#419 id=419 data-nosnippet>419</a>
<a href=#420 id=420 data-nosnippet>420</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;u8, Error&gt; {
<a href=#421 id=421 data-nosnippet>421</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#422 id=422 data-nosnippet>422</a>
<a href=#423 id=423 data-nosnippet>423</a> connect_flags |= <span class="number">0x04 </span>| (<span class="self">self</span>.qos <span class="kw">as </span>u8) &lt;&lt; <span class="number">3</span>;
<a href=#424 id=424 data-nosnippet>424</a> <span class="kw">if </span><span class="self">self</span>.retain {
<a href=#425 id=425 data-nosnippet>425</a> connect_flags |= <span class="number">0x20</span>;
<a href=#426 id=426 data-nosnippet>426</a> }
<a href=#427 id=427 data-nosnippet>427</a>
<a href=#428 id=428 data-nosnippet>428</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#429 id=429 data-nosnippet>429</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#430 id=430 data-nosnippet>430</a> } <span class="kw">else </span>{
<a href=#431 id=431 data-nosnippet>431</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#432 id=432 data-nosnippet>432</a> }
<a href=#433 id=433 data-nosnippet>433</a>
<a href=#434 id=434 data-nosnippet>434</a> write_mqtt_bytes(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.topic);
<a href=#435 id=435 data-nosnippet>435</a> write_mqtt_bytes(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.message);
<a href=#436 id=436 data-nosnippet>436</a> <span class="prelude-val">Ok</span>(connect_flags)
<a href=#437 id=437 data-nosnippet>437</a> }
<a href=#438 id=438 data-nosnippet>438</a>}
<a href=#439 id=439 data-nosnippet>439</a>
<a href=#440 id=440 data-nosnippet>440</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#441 id=441 data-nosnippet>441</a></span><span class="kw">pub struct </span>LastWillProperties {
<a href=#442 id=442 data-nosnippet>442</a> <span class="kw">pub </span>delay_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#443 id=443 data-nosnippet>443</a> <span class="kw">pub </span>payload_format_indicator: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#444 id=444 data-nosnippet>444</a> <span class="kw">pub </span>message_expiry_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#445 id=445 data-nosnippet>445</a> <span class="kw">pub </span>content_type: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#446 id=446 data-nosnippet>446</a> <span class="kw">pub </span>response_topic: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#447 id=447 data-nosnippet>447</a> <span class="kw">pub </span>correlation_data: <span class="prelude-ty">Option</span>&lt;Bytes&gt;,
<a href=#448 id=448 data-nosnippet>448</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#449 id=449 data-nosnippet>449</a>}
<a href=#450 id=450 data-nosnippet>450</a>
<a href=#451 id=451 data-nosnippet>451</a><span class="kw">impl </span>LastWillProperties {
<a href=#452 id=452 data-nosnippet>452</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#453 id=453 data-nosnippet>453</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#454 id=454 data-nosnippet>454</a>
<a href=#455 id=455 data-nosnippet>455</a> <span class="kw">if </span><span class="self">self</span>.delay_interval.is_some() {
<a href=#456 id=456 data-nosnippet>456</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#457 id=457 data-nosnippet>457</a> }
<a href=#458 id=458 data-nosnippet>458</a>
<a href=#459 id=459 data-nosnippet>459</a> <span class="kw">if </span><span class="self">self</span>.payload_format_indicator.is_some() {
<a href=#460 id=460 data-nosnippet>460</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#461 id=461 data-nosnippet>461</a> }
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a> <span class="kw">if </span><span class="self">self</span>.message_expiry_interval.is_some() {
<a href=#464 id=464 data-nosnippet>464</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#465 id=465 data-nosnippet>465</a> }
<a href=#466 id=466 data-nosnippet>466</a>
<a href=#467 id=467 data-nosnippet>467</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(typ) = <span class="kw-2">&amp;</span><span class="self">self</span>.content_type {
<a href=#468 id=468 data-nosnippet>468</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ typ.len()
<a href=#469 id=469 data-nosnippet>469</a> }
<a href=#470 id=470 data-nosnippet>470</a>
<a href=#471 id=471 data-nosnippet>471</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_topic {
<a href=#472 id=472 data-nosnippet>472</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ topic.len()
<a href=#473 id=473 data-nosnippet>473</a> }
<a href=#474 id=474 data-nosnippet>474</a>
<a href=#475 id=475 data-nosnippet>475</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = <span class="kw-2">&amp;</span><span class="self">self</span>.correlation_data {
<a href=#476 id=476 data-nosnippet>476</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ data.len()
<a href=#477 id=477 data-nosnippet>477</a> }
<a href=#478 id=478 data-nosnippet>478</a>
<a href=#479 id=479 data-nosnippet>479</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#480 id=480 data-nosnippet>480</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#481 id=481 data-nosnippet>481</a> }
<a href=#482 id=482 data-nosnippet>482</a>
<a href=#483 id=483 data-nosnippet>483</a> len
<a href=#484 id=484 data-nosnippet>484</a> }
<a href=#485 id=485 data-nosnippet>485</a>
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;LastWillProperties&gt;, Error&gt; {
<a href=#487 id=487 data-nosnippet>487</a> <span class="kw">let </span><span class="kw-2">mut </span>delay_interval = <span class="prelude-val">None</span>;
<a href=#488 id=488 data-nosnippet>488</a> <span class="kw">let </span><span class="kw-2">mut </span>payload_format_indicator = <span class="prelude-val">None</span>;
<a href=#489 id=489 data-nosnippet>489</a> <span class="kw">let </span><span class="kw-2">mut </span>message_expiry_interval = <span class="prelude-val">None</span>;
<a href=#490 id=490 data-nosnippet>490</a> <span class="kw">let </span><span class="kw-2">mut </span>content_type = <span class="prelude-val">None</span>;
<a href=#491 id=491 data-nosnippet>491</a> <span class="kw">let </span><span class="kw-2">mut </span>response_topic = <span class="prelude-val">None</span>;
<a href=#492 id=492 data-nosnippet>492</a> <span class="kw">let </span><span class="kw-2">mut </span>correlation_data = <span class="prelude-val">None</span>;
<a href=#493 id=493 data-nosnippet>493</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#494 id=494 data-nosnippet>494</a>
<a href=#495 id=495 data-nosnippet>495</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#496 id=496 data-nosnippet>496</a> bytes.advance(properties_len_len);
<a href=#497 id=497 data-nosnippet>497</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#498 id=498 data-nosnippet>498</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#499 id=499 data-nosnippet>499</a> }
<a href=#500 id=500 data-nosnippet>500</a>
<a href=#501 id=501 data-nosnippet>501</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#502 id=502 data-nosnippet>502</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#503 id=503 data-nosnippet>503</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#504 id=504 data-nosnippet>504</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#505 id=505 data-nosnippet>505</a> cursor += <span class="number">1</span>;
<a href=#506 id=506 data-nosnippet>506</a>
<a href=#507 id=507 data-nosnippet>507</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#508 id=508 data-nosnippet>508</a> PropertyType::WillDelayInterval =&gt; {
<a href=#509 id=509 data-nosnippet>509</a> delay_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#510 id=510 data-nosnippet>510</a> cursor += <span class="number">4</span>;
<a href=#511 id=511 data-nosnippet>511</a> }
<a href=#512 id=512 data-nosnippet>512</a> PropertyType::PayloadFormatIndicator =&gt; {
<a href=#513 id=513 data-nosnippet>513</a> payload_format_indicator = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#514 id=514 data-nosnippet>514</a> cursor += <span class="number">1</span>;
<a href=#515 id=515 data-nosnippet>515</a> }
<a href=#516 id=516 data-nosnippet>516</a> PropertyType::MessageExpiryInterval =&gt; {
<a href=#517 id=517 data-nosnippet>517</a> message_expiry_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#518 id=518 data-nosnippet>518</a> cursor += <span class="number">4</span>;
<a href=#519 id=519 data-nosnippet>519</a> }
<a href=#520 id=520 data-nosnippet>520</a> PropertyType::ContentType =&gt; {
<a href=#521 id=521 data-nosnippet>521</a> <span class="kw">let </span>typ = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#522 id=522 data-nosnippet>522</a> cursor += <span class="number">2 </span>+ typ.len();
<a href=#523 id=523 data-nosnippet>523</a> content_type = <span class="prelude-val">Some</span>(typ);
<a href=#524 id=524 data-nosnippet>524</a> }
<a href=#525 id=525 data-nosnippet>525</a> PropertyType::ResponseTopic =&gt; {
<a href=#526 id=526 data-nosnippet>526</a> <span class="kw">let </span>topic = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#527 id=527 data-nosnippet>527</a> cursor += <span class="number">2 </span>+ topic.len();
<a href=#528 id=528 data-nosnippet>528</a> response_topic = <span class="prelude-val">Some</span>(topic);
<a href=#529 id=529 data-nosnippet>529</a> }
<a href=#530 id=530 data-nosnippet>530</a> PropertyType::CorrelationData =&gt; {
<a href=#531 id=531 data-nosnippet>531</a> <span class="kw">let </span>data = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#532 id=532 data-nosnippet>532</a> cursor += <span class="number">2 </span>+ data.len();
<a href=#533 id=533 data-nosnippet>533</a> correlation_data = <span class="prelude-val">Some</span>(data);
<a href=#534 id=534 data-nosnippet>534</a> }
<a href=#535 id=535 data-nosnippet>535</a> PropertyType::UserProperty =&gt; {
<a href=#536 id=536 data-nosnippet>536</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#537 id=537 data-nosnippet>537</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#538 id=538 data-nosnippet>538</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#539 id=539 data-nosnippet>539</a> user_properties.push((key, value));
<a href=#540 id=540 data-nosnippet>540</a> }
<a href=#541 id=541 data-nosnippet>541</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#542 id=542 data-nosnippet>542</a> }
<a href=#543 id=543 data-nosnippet>543</a> }
<a href=#544 id=544 data-nosnippet>544</a>
<a href=#545 id=545 data-nosnippet>545</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(LastWillProperties {
<a href=#546 id=546 data-nosnippet>546</a> delay_interval,
<a href=#547 id=547 data-nosnippet>547</a> payload_format_indicator,
<a href=#548 id=548 data-nosnippet>548</a> message_expiry_interval,
<a href=#549 id=549 data-nosnippet>549</a> content_type,
<a href=#550 id=550 data-nosnippet>550</a> response_topic,
<a href=#551 id=551 data-nosnippet>551</a> correlation_data,
<a href=#552 id=552 data-nosnippet>552</a> user_properties,
<a href=#553 id=553 data-nosnippet>553</a> }))
<a href=#554 id=554 data-nosnippet>554</a> }
<a href=#555 id=555 data-nosnippet>555</a>
<a href=#556 id=556 data-nosnippet>556</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#557 id=557 data-nosnippet>557</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#558 id=558 data-nosnippet>558</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#559 id=559 data-nosnippet>559</a>
<a href=#560 id=560 data-nosnippet>560</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(delay_interval) = <span class="self">self</span>.delay_interval {
<a href=#561 id=561 data-nosnippet>561</a> buffer.put_u8(PropertyType::WillDelayInterval <span class="kw">as </span>u8);
<a href=#562 id=562 data-nosnippet>562</a> buffer.put_u32(delay_interval);
<a href=#563 id=563 data-nosnippet>563</a> }
<a href=#564 id=564 data-nosnippet>564</a>
<a href=#565 id=565 data-nosnippet>565</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(payload_format_indicator) = <span class="self">self</span>.payload_format_indicator {
<a href=#566 id=566 data-nosnippet>566</a> buffer.put_u8(PropertyType::PayloadFormatIndicator <span class="kw">as </span>u8);
<a href=#567 id=567 data-nosnippet>567</a> buffer.put_u8(payload_format_indicator);
<a href=#568 id=568 data-nosnippet>568</a> }
<a href=#569 id=569 data-nosnippet>569</a>
<a href=#570 id=570 data-nosnippet>570</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(message_expiry_interval) = <span class="self">self</span>.message_expiry_interval {
<a href=#571 id=571 data-nosnippet>571</a> buffer.put_u8(PropertyType::MessageExpiryInterval <span class="kw">as </span>u8);
<a href=#572 id=572 data-nosnippet>572</a> buffer.put_u32(message_expiry_interval);
<a href=#573 id=573 data-nosnippet>573</a> }
<a href=#574 id=574 data-nosnippet>574</a>
<a href=#575 id=575 data-nosnippet>575</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(typ) = <span class="kw-2">&amp;</span><span class="self">self</span>.content_type {
<a href=#576 id=576 data-nosnippet>576</a> buffer.put_u8(PropertyType::ContentType <span class="kw">as </span>u8);
<a href=#577 id=577 data-nosnippet>577</a> write_mqtt_string(buffer, typ);
<a href=#578 id=578 data-nosnippet>578</a> }
<a href=#579 id=579 data-nosnippet>579</a>
<a href=#580 id=580 data-nosnippet>580</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_topic {
<a href=#581 id=581 data-nosnippet>581</a> buffer.put_u8(PropertyType::ResponseTopic <span class="kw">as </span>u8);
<a href=#582 id=582 data-nosnippet>582</a> write_mqtt_string(buffer, topic);
<a href=#583 id=583 data-nosnippet>583</a> }
<a href=#584 id=584 data-nosnippet>584</a>
<a href=#585 id=585 data-nosnippet>585</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = <span class="kw-2">&amp;</span><span class="self">self</span>.correlation_data {
<a href=#586 id=586 data-nosnippet>586</a> buffer.put_u8(PropertyType::CorrelationData <span class="kw">as </span>u8);
<a href=#587 id=587 data-nosnippet>587</a> write_mqtt_bytes(buffer, data);
<a href=#588 id=588 data-nosnippet>588</a> }
<a href=#589 id=589 data-nosnippet>589</a>
<a href=#590 id=590 data-nosnippet>590</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#591 id=591 data-nosnippet>591</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#592 id=592 data-nosnippet>592</a> write_mqtt_string(buffer, key);
<a href=#593 id=593 data-nosnippet>593</a> write_mqtt_string(buffer, value);
<a href=#594 id=594 data-nosnippet>594</a> }
<a href=#595 id=595 data-nosnippet>595</a>
<a href=#596 id=596 data-nosnippet>596</a> <span class="prelude-val">Ok</span>(())
<a href=#597 id=597 data-nosnippet>597</a> }
<a href=#598 id=598 data-nosnippet>598</a>}
<a href=#599 id=599 data-nosnippet>599</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#600 id=600 data-nosnippet>600</a></span><span class="kw">pub struct </span>Login {
<a href=#601 id=601 data-nosnippet>601</a> <span class="kw">pub </span>username: String,
<a href=#602 id=602 data-nosnippet>602</a> <span class="kw">pub </span>password: String,
<a href=#603 id=603 data-nosnippet>603</a>}
<a href=#604 id=604 data-nosnippet>604</a>
<a href=#605 id=605 data-nosnippet>605</a><span class="kw">impl </span>Login {
<a href=#606 id=606 data-nosnippet>606</a> <span class="kw">pub fn </span>new&lt;U: Into&lt;String&gt;, P: Into&lt;String&gt;&gt;(u: U, p: P) -&gt; Login {
<a href=#607 id=607 data-nosnippet>607</a> Login {
<a href=#608 id=608 data-nosnippet>608</a> username: u.into(),
<a href=#609 id=609 data-nosnippet>609</a> password: p.into(),
<a href=#610 id=610 data-nosnippet>610</a> }
<a href=#611 id=611 data-nosnippet>611</a> }
<a href=#612 id=612 data-nosnippet>612</a>
<a href=#613 id=613 data-nosnippet>613</a> <span class="kw">pub fn </span>read(connect_flags: u8, bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;Login&gt;, Error&gt; {
<a href=#614 id=614 data-nosnippet>614</a> <span class="kw">let </span>username = <span class="kw">match </span>connect_flags &amp; <span class="number">0b1000_0000 </span>{
<a href=#615 id=615 data-nosnippet>615</a> <span class="number">0 </span>=&gt; String::new(),
<a href=#616 id=616 data-nosnippet>616</a> <span class="kw">_ </span>=&gt; read_mqtt_string(bytes)<span class="question-mark">?</span>,
<a href=#617 id=617 data-nosnippet>617</a> };
<a href=#618 id=618 data-nosnippet>618</a>
<a href=#619 id=619 data-nosnippet>619</a> <span class="kw">let </span>password = <span class="kw">match </span>connect_flags &amp; <span class="number">0b0100_0000 </span>{
<a href=#620 id=620 data-nosnippet>620</a> <span class="number">0 </span>=&gt; String::new(),
<a href=#621 id=621 data-nosnippet>621</a> <span class="kw">_ </span>=&gt; read_mqtt_string(bytes)<span class="question-mark">?</span>,
<a href=#622 id=622 data-nosnippet>622</a> };
<a href=#623 id=623 data-nosnippet>623</a>
<a href=#624 id=624 data-nosnippet>624</a> <span class="kw">if </span>username.is_empty() &amp;&amp; password.is_empty() {
<a href=#625 id=625 data-nosnippet>625</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
<a href=#626 id=626 data-nosnippet>626</a> } <span class="kw">else </span>{
<a href=#627 id=627 data-nosnippet>627</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(Login { username, password }))
<a href=#628 id=628 data-nosnippet>628</a> }
<a href=#629 id=629 data-nosnippet>629</a> }
<a href=#630 id=630 data-nosnippet>630</a>
<a href=#631 id=631 data-nosnippet>631</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#632 id=632 data-nosnippet>632</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#633 id=633 data-nosnippet>633</a>
<a href=#634 id=634 data-nosnippet>634</a> <span class="kw">if </span>!<span class="self">self</span>.username.is_empty() {
<a href=#635 id=635 data-nosnippet>635</a> len += <span class="number">2 </span>+ <span class="self">self</span>.username.len();
<a href=#636 id=636 data-nosnippet>636</a> }
<a href=#637 id=637 data-nosnippet>637</a>
<a href=#638 id=638 data-nosnippet>638</a> <span class="kw">if </span>!<span class="self">self</span>.password.is_empty() {
<a href=#639 id=639 data-nosnippet>639</a> len += <span class="number">2 </span>+ <span class="self">self</span>.password.len();
<a href=#640 id=640 data-nosnippet>640</a> }
<a href=#641 id=641 data-nosnippet>641</a>
<a href=#642 id=642 data-nosnippet>642</a> len
<a href=#643 id=643 data-nosnippet>643</a> }
<a href=#644 id=644 data-nosnippet>644</a>
<a href=#645 id=645 data-nosnippet>645</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; u8 {
<a href=#646 id=646 data-nosnippet>646</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#647 id=647 data-nosnippet>647</a> <span class="kw">if </span>!<span class="self">self</span>.username.is_empty() {
<a href=#648 id=648 data-nosnippet>648</a> connect_flags |= <span class="number">0x80</span>;
<a href=#649 id=649 data-nosnippet>649</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.username);
<a href=#650 id=650 data-nosnippet>650</a> }
<a href=#651 id=651 data-nosnippet>651</a>
<a href=#652 id=652 data-nosnippet>652</a> <span class="kw">if </span>!<span class="self">self</span>.password.is_empty() {
<a href=#653 id=653 data-nosnippet>653</a> connect_flags |= <span class="number">0x40</span>;
<a href=#654 id=654 data-nosnippet>654</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.password);
<a href=#655 id=655 data-nosnippet>655</a> }
<a href=#656 id=656 data-nosnippet>656</a>
<a href=#657 id=657 data-nosnippet>657</a> connect_flags
<a href=#658 id=658 data-nosnippet>658</a> }
<a href=#659 id=659 data-nosnippet>659</a>}
<a href=#660 id=660 data-nosnippet>660</a>
<a href=#661 id=661 data-nosnippet>661</a><span class="attr">#[cfg(test)]
<a href=#662 id=662 data-nosnippet>662</a></span><span class="kw">mod </span>test {
<a href=#663 id=663 data-nosnippet>663</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#664 id=664 data-nosnippet>664</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#665 id=665 data-nosnippet>665</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#666 id=666 data-nosnippet>666</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#667 id=667 data-nosnippet>667</a>
<a href=#668 id=668 data-nosnippet>668</a> <span class="attr">#[test]
<a href=#669 id=669 data-nosnippet>669</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#670 id=670 data-nosnippet>670</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#671 id=671 data-nosnippet>671</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_props = ConnectProperties::new();
<a href=#672 id=672 data-nosnippet>672</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#673 id=673 data-nosnippet>673</a> // remaining_length field in the packet be 2 bytes long.
<a href=#674 id=674 data-nosnippet>674</a> </span>connect_props.user_properties = <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())];
<a href=#675 id=675 data-nosnippet>675</a> <span class="kw">let </span>connect_pkt = Connect {
<a href=#676 id=676 data-nosnippet>676</a> keep_alive: <span class="number">5</span>,
<a href=#677 id=677 data-nosnippet>677</a> client_id: <span class="string">"client"</span>.into(),
<a href=#678 id=678 data-nosnippet>678</a> clean_start: <span class="bool-val">true</span>,
<a href=#679 id=679 data-nosnippet>679</a> properties: <span class="prelude-val">Some</span>(connect_props),
<a href=#680 id=680 data-nosnippet>680</a> };
<a href=#681 id=681 data-nosnippet>681</a>
<a href=#682 id=682 data-nosnippet>682</a> <span class="kw">let </span>reported_size = connect_pkt.write(<span class="kw-2">&amp;</span><span class="prelude-val">None</span>, <span class="kw-2">&amp;</span><span class="prelude-val">None</span>, <span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#683 id=683 data-nosnippet>683</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#684 id=684 data-nosnippet>684</a>
<a href=#685 id=685 data-nosnippet>685</a> <span class="macro">assert_eq!</span>(reported_size, size_from_bytes);
<a href=#686 id=686 data-nosnippet>686</a> }
<a href=#687 id=687 data-nosnippet>687</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,470 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/disconnect.rs`."><title>disconnect.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>disconnect.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::convert::{TryFrom, TryInto};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>bytes::{BufMut, Bytes, BytesMut};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use super</span>::{property, PropertyType};
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#10 id=10 data-nosnippet>10</a>#[repr(u8)]
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">pub enum </span>DisconnectReasonCode {
<a href=#12 id=12 data-nosnippet>12</a> <span class="doccomment">/// Close the connection normally. Do not send the Will Message.
<a href=#13 id=13 data-nosnippet>13</a> </span>NormalDisconnection = <span class="number">0x00</span>,
<a href=#14 id=14 data-nosnippet>14</a> <span class="doccomment">/// The Client wishes to disconnect but requires that the Server also publishes its Will Message.
<a href=#15 id=15 data-nosnippet>15</a> </span>DisconnectWithWillMessage = <span class="number">0x04</span>,
<a href=#16 id=16 data-nosnippet>16</a> <span class="doccomment">/// The Connection is closed but the sender either does not wish to reveal the reason, or none of the other Reason Codes apply.
<a href=#17 id=17 data-nosnippet>17</a> </span>UnspecifiedError = <span class="number">0x80</span>,
<a href=#18 id=18 data-nosnippet>18</a> <span class="doccomment">/// The received packet does not conform to this specification.
<a href=#19 id=19 data-nosnippet>19</a> </span>MalformedPacket = <span class="number">0x81</span>,
<a href=#20 id=20 data-nosnippet>20</a> <span class="doccomment">/// An unexpected or out of order packet was received.
<a href=#21 id=21 data-nosnippet>21</a> </span>ProtocolError = <span class="number">0x82</span>,
<a href=#22 id=22 data-nosnippet>22</a> <span class="doccomment">/// The packet received is valid but cannot be processed by this implementation.
<a href=#23 id=23 data-nosnippet>23</a> </span>ImplementationSpecificError = <span class="number">0x83</span>,
<a href=#24 id=24 data-nosnippet>24</a> <span class="doccomment">/// The request is not authorized.
<a href=#25 id=25 data-nosnippet>25</a> </span>NotAuthorized = <span class="number">0x87</span>,
<a href=#26 id=26 data-nosnippet>26</a> <span class="doccomment">/// The Server is busy and cannot continue processing requests from this Client.
<a href=#27 id=27 data-nosnippet>27</a> </span>ServerBusy = <span class="number">0x89</span>,
<a href=#28 id=28 data-nosnippet>28</a> <span class="doccomment">/// The Server is shutting down.
<a href=#29 id=29 data-nosnippet>29</a> </span>ServerShuttingDown = <span class="number">0x8B</span>,
<a href=#30 id=30 data-nosnippet>30</a> <span class="doccomment">/// The Connection is closed because no packet has been received for 1.5 times the Keepalive time.
<a href=#31 id=31 data-nosnippet>31</a> </span>KeepAliveTimeout = <span class="number">0x8D</span>,
<a href=#32 id=32 data-nosnippet>32</a> <span class="doccomment">/// Another Connection using the same ClientID has connected causing this Connection to be closed.
<a href=#33 id=33 data-nosnippet>33</a> </span>SessionTakenOver = <span class="number">0x8E</span>,
<a href=#34 id=34 data-nosnippet>34</a> <span class="doccomment">/// The Topic Filter is correctly formed, but is not accepted by this Sever.
<a href=#35 id=35 data-nosnippet>35</a> </span>TopicFilterInvalid = <span class="number">0x8F</span>,
<a href=#36 id=36 data-nosnippet>36</a> <span class="doccomment">/// The Topic Name is correctly formed, but is not accepted by this Client or Server.
<a href=#37 id=37 data-nosnippet>37</a> </span>TopicNameInvalid = <span class="number">0x90</span>,
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// The Client or Server has received more than Receive Maximum publication for which it has not sent PUBACK or PUBCOMP.
<a href=#39 id=39 data-nosnippet>39</a> </span>ReceiveMaximumExceeded = <span class="number">0x93</span>,
<a href=#40 id=40 data-nosnippet>40</a> <span class="doccomment">/// The Client or Server has received a PUBLISH packet containing a Topic Alias which is greater than the Maximum Topic Alias it sent in the CONNECT or CONNACK packet.
<a href=#41 id=41 data-nosnippet>41</a> </span>TopicAliasInvalid = <span class="number">0x94</span>,
<a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// The packet size is greater than Maximum Packet Size for this Client or Server.
<a href=#43 id=43 data-nosnippet>43</a> </span>PacketTooLarge = <span class="number">0x95</span>,
<a href=#44 id=44 data-nosnippet>44</a> <span class="doccomment">/// The received data rate is too high.
<a href=#45 id=45 data-nosnippet>45</a> </span>MessageRateTooHigh = <span class="number">0x96</span>,
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// An implementation or administrative imposed limit has been exceeded.
<a href=#47 id=47 data-nosnippet>47</a> </span>QuotaExceeded = <span class="number">0x97</span>,
<a href=#48 id=48 data-nosnippet>48</a> <span class="doccomment">/// The Connection is closed due to an administrative action.
<a href=#49 id=49 data-nosnippet>49</a> </span>AdministrativeAction = <span class="number">0x98</span>,
<a href=#50 id=50 data-nosnippet>50</a> <span class="doccomment">/// The payload format does not match the one specified by the Payload Format Indicator.
<a href=#51 id=51 data-nosnippet>51</a> </span>PayloadFormatInvalid = <span class="number">0x99</span>,
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// The Server has does not support retained messages.
<a href=#53 id=53 data-nosnippet>53</a> </span>RetainNotSupported = <span class="number">0x9A</span>,
<a href=#54 id=54 data-nosnippet>54</a> <span class="doccomment">/// The Client specified a QoS greater than the QoS specified in a Maximum QoS in the CONNACK.
<a href=#55 id=55 data-nosnippet>55</a> </span>QoSNotSupported = <span class="number">0x9B</span>,
<a href=#56 id=56 data-nosnippet>56</a> <span class="doccomment">/// The Client should temporarily change its Server.
<a href=#57 id=57 data-nosnippet>57</a> </span>UseAnotherServer = <span class="number">0x9C</span>,
<a href=#58 id=58 data-nosnippet>58</a> <span class="doccomment">/// The Server is moved and the Client should permanently change its server location.
<a href=#59 id=59 data-nosnippet>59</a> </span>ServerMoved = <span class="number">0x9D</span>,
<a href=#60 id=60 data-nosnippet>60</a> <span class="doccomment">/// The Server does not support Shared Subscriptions.
<a href=#61 id=61 data-nosnippet>61</a> </span>SharedSubscriptionNotSupported = <span class="number">0x9E</span>,
<a href=#62 id=62 data-nosnippet>62</a> <span class="doccomment">/// This connection is closed because the connection rate is too high.
<a href=#63 id=63 data-nosnippet>63</a> </span>ConnectionRateExceeded = <span class="number">0x9F</span>,
<a href=#64 id=64 data-nosnippet>64</a> <span class="doccomment">/// The maximum connection time authorized for this connection has been exceeded.
<a href=#65 id=65 data-nosnippet>65</a> </span>MaximumConnectTime = <span class="number">0xA0</span>,
<a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// The Server does not support Subscription Identifiers; the subscription is not accepted.
<a href=#67 id=67 data-nosnippet>67</a> </span>SubscriptionIdentifiersNotSupported = <span class="number">0xA1</span>,
<a href=#68 id=68 data-nosnippet>68</a> <span class="doccomment">/// The Server does not support Wildcard subscription; the subscription is not accepted.
<a href=#69 id=69 data-nosnippet>69</a> </span>WildcardSubscriptionsNotSupported = <span class="number">0xA2</span>,
<a href=#70 id=70 data-nosnippet>70</a>}
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="kw">impl </span>TryFrom&lt;u8&gt; <span class="kw">for </span>DisconnectReasonCode {
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">type </span>Error = Error;
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">fn </span>try_from(value: u8) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="self">Self</span>::Error&gt; {
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>rc = <span class="kw">match </span>value {
<a href=#77 id=77 data-nosnippet>77</a> <span class="number">0x00 </span>=&gt; <span class="self">Self</span>::NormalDisconnection,
<a href=#78 id=78 data-nosnippet>78</a> <span class="number">0x04 </span>=&gt; <span class="self">Self</span>::DisconnectWithWillMessage,
<a href=#79 id=79 data-nosnippet>79</a> <span class="number">0x80 </span>=&gt; <span class="self">Self</span>::UnspecifiedError,
<a href=#80 id=80 data-nosnippet>80</a> <span class="number">0x81 </span>=&gt; <span class="self">Self</span>::MalformedPacket,
<a href=#81 id=81 data-nosnippet>81</a> <span class="number">0x82 </span>=&gt; <span class="self">Self</span>::ProtocolError,
<a href=#82 id=82 data-nosnippet>82</a> <span class="number">0x83 </span>=&gt; <span class="self">Self</span>::ImplementationSpecificError,
<a href=#83 id=83 data-nosnippet>83</a> <span class="number">0x87 </span>=&gt; <span class="self">Self</span>::NotAuthorized,
<a href=#84 id=84 data-nosnippet>84</a> <span class="number">0x89 </span>=&gt; <span class="self">Self</span>::ServerBusy,
<a href=#85 id=85 data-nosnippet>85</a> <span class="number">0x8B </span>=&gt; <span class="self">Self</span>::ServerShuttingDown,
<a href=#86 id=86 data-nosnippet>86</a> <span class="number">0x8D </span>=&gt; <span class="self">Self</span>::KeepAliveTimeout,
<a href=#87 id=87 data-nosnippet>87</a> <span class="number">0x8E </span>=&gt; <span class="self">Self</span>::SessionTakenOver,
<a href=#88 id=88 data-nosnippet>88</a> <span class="number">0x8F </span>=&gt; <span class="self">Self</span>::TopicFilterInvalid,
<a href=#89 id=89 data-nosnippet>89</a> <span class="number">0x90 </span>=&gt; <span class="self">Self</span>::TopicNameInvalid,
<a href=#90 id=90 data-nosnippet>90</a> <span class="number">0x93 </span>=&gt; <span class="self">Self</span>::ReceiveMaximumExceeded,
<a href=#91 id=91 data-nosnippet>91</a> <span class="number">0x94 </span>=&gt; <span class="self">Self</span>::TopicAliasInvalid,
<a href=#92 id=92 data-nosnippet>92</a> <span class="number">0x95 </span>=&gt; <span class="self">Self</span>::PacketTooLarge,
<a href=#93 id=93 data-nosnippet>93</a> <span class="number">0x96 </span>=&gt; <span class="self">Self</span>::MessageRateTooHigh,
<a href=#94 id=94 data-nosnippet>94</a> <span class="number">0x97 </span>=&gt; <span class="self">Self</span>::QuotaExceeded,
<a href=#95 id=95 data-nosnippet>95</a> <span class="number">0x98 </span>=&gt; <span class="self">Self</span>::AdministrativeAction,
<a href=#96 id=96 data-nosnippet>96</a> <span class="number">0x99 </span>=&gt; <span class="self">Self</span>::PayloadFormatInvalid,
<a href=#97 id=97 data-nosnippet>97</a> <span class="number">0x9A </span>=&gt; <span class="self">Self</span>::RetainNotSupported,
<a href=#98 id=98 data-nosnippet>98</a> <span class="number">0x9B </span>=&gt; <span class="self">Self</span>::QoSNotSupported,
<a href=#99 id=99 data-nosnippet>99</a> <span class="number">0x9C </span>=&gt; <span class="self">Self</span>::UseAnotherServer,
<a href=#100 id=100 data-nosnippet>100</a> <span class="number">0x9D </span>=&gt; <span class="self">Self</span>::ServerMoved,
<a href=#101 id=101 data-nosnippet>101</a> <span class="number">0x9E </span>=&gt; <span class="self">Self</span>::SharedSubscriptionNotSupported,
<a href=#102 id=102 data-nosnippet>102</a> <span class="number">0x9F </span>=&gt; <span class="self">Self</span>::ConnectionRateExceeded,
<a href=#103 id=103 data-nosnippet>103</a> <span class="number">0xA0 </span>=&gt; <span class="self">Self</span>::MaximumConnectTime,
<a href=#104 id=104 data-nosnippet>104</a> <span class="number">0xA1 </span>=&gt; <span class="self">Self</span>::SubscriptionIdentifiersNotSupported,
<a href=#105 id=105 data-nosnippet>105</a> <span class="number">0xA2 </span>=&gt; <span class="self">Self</span>::WildcardSubscriptionsNotSupported,
<a href=#106 id=106 data-nosnippet>106</a> other =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(other)),
<a href=#107 id=107 data-nosnippet>107</a> };
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="prelude-val">Ok</span>(rc)
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>}
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#114 id=114 data-nosnippet>114</a></span><span class="kw">pub struct </span>DisconnectProperties {
<a href=#115 id=115 data-nosnippet>115</a> <span class="doccomment">/// Session Expiry Interval in seconds
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="kw">pub </span>session_expiry_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a> <span class="doccomment">/// Human readable reason for the disconnect
<a href=#119 id=119 data-nosnippet>119</a> </span><span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="doccomment">/// List of user properties
<a href=#122 id=122 data-nosnippet>122</a> </span><span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// String which can be used by the Client to identify another Server to use.
<a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">pub </span>server_reference: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#126 id=126 data-nosnippet>126</a>}
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#129 id=129 data-nosnippet>129</a></span><span class="kw">pub struct </span>Disconnect {
<a href=#130 id=130 data-nosnippet>130</a> <span class="doccomment">/// Disconnect Reason Code
<a href=#131 id=131 data-nosnippet>131</a> </span><span class="kw">pub </span>reason_code: DisconnectReasonCode,
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> <span class="doccomment">/// Disconnect Properties
<a href=#134 id=134 data-nosnippet>134</a> </span><span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;DisconnectProperties&gt;,
<a href=#135 id=135 data-nosnippet>135</a>}
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a><span class="kw">impl </span>DisconnectProperties {
<a href=#138 id=138 data-nosnippet>138</a> <span class="comment">// pub fn new() -&gt; Self {
<a href=#139 id=139 data-nosnippet>139</a> // Self {
<a href=#140 id=140 data-nosnippet>140</a> // session_expiry_interval: None,
<a href=#141 id=141 data-nosnippet>141</a> // reason_string: None,
<a href=#142 id=142 data-nosnippet>142</a> // user_properties: Vec::new(),
<a href=#143 id=143 data-nosnippet>143</a> // server_reference: None,
<a href=#144 id=144 data-nosnippet>144</a> // }
<a href=#145 id=145 data-nosnippet>145</a> // }
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> </span><span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">let </span><span class="kw-2">mut </span>length = <span class="number">0</span>;
<a href=#149 id=149 data-nosnippet>149</a>
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">if </span><span class="self">self</span>.session_expiry_interval.is_some() {
<a href=#151 id=151 data-nosnippet>151</a> length += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#155 id=155 data-nosnippet>155</a> length += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#156 id=156 data-nosnippet>156</a> }
<a href=#157 id=157 data-nosnippet>157</a>
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#159 id=159 data-nosnippet>159</a> length += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#160 id=160 data-nosnippet>160</a> }
<a href=#161 id=161 data-nosnippet>161</a>
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(server_reference) = <span class="kw-2">&amp;</span><span class="self">self</span>.server_reference {
<a href=#163 id=163 data-nosnippet>163</a> length += <span class="number">1 </span>+ <span class="number">2 </span>+ server_reference.len();
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> length
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">pub fn </span>extract(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt;, Error&gt; {
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#171 id=171 data-nosnippet>171</a>
<a href=#172 id=172 data-nosnippet>172</a> bytes.advance(properties_len_len);
<a href=#173 id=173 data-nosnippet>173</a>
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#176 id=176 data-nosnippet>176</a> }
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">let </span><span class="kw-2">mut </span>session_expiry_interval = <span class="prelude-val">None</span>;
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">let </span><span class="kw-2">mut </span>server_reference = <span class="prelude-val">None</span>;
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#186 id=186 data-nosnippet>186</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#187 id=187 data-nosnippet>187</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#188 id=188 data-nosnippet>188</a> cursor += <span class="number">1</span>;
<a href=#189 id=189 data-nosnippet>189</a>
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#191 id=191 data-nosnippet>191</a> PropertyType::SessionExpiryInterval =&gt; {
<a href=#192 id=192 data-nosnippet>192</a> session_expiry_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#193 id=193 data-nosnippet>193</a> cursor += <span class="number">4</span>;
<a href=#194 id=194 data-nosnippet>194</a> }
<a href=#195 id=195 data-nosnippet>195</a> PropertyType::ReasonString =&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#197 id=197 data-nosnippet>197</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#198 id=198 data-nosnippet>198</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#199 id=199 data-nosnippet>199</a> }
<a href=#200 id=200 data-nosnippet>200</a> PropertyType::UserProperty =&gt; {
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#203 id=203 data-nosnippet>203</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#204 id=204 data-nosnippet>204</a> user_properties.push((key, value));
<a href=#205 id=205 data-nosnippet>205</a> }
<a href=#206 id=206 data-nosnippet>206</a> PropertyType::ServerReference =&gt; {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span>reference = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#208 id=208 data-nosnippet>208</a> cursor += <span class="number">2 </span>+ reference.len();
<a href=#209 id=209 data-nosnippet>209</a> server_reference = <span class="prelude-val">Some</span>(reference);
<a href=#210 id=210 data-nosnippet>210</a> }
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#212 id=212 data-nosnippet>212</a> }
<a href=#213 id=213 data-nosnippet>213</a> }
<a href=#214 id=214 data-nosnippet>214</a>
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span>properties = <span class="self">Self </span>{
<a href=#216 id=216 data-nosnippet>216</a> session_expiry_interval,
<a href=#217 id=217 data-nosnippet>217</a> reason_string,
<a href=#218 id=218 data-nosnippet>218</a> user_properties,
<a href=#219 id=219 data-nosnippet>219</a> server_reference,
<a href=#220 id=220 data-nosnippet>220</a> };
<a href=#221 id=221 data-nosnippet>221</a>
<a href=#222 id=222 data-nosnippet>222</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(properties))
<a href=#223 id=223 data-nosnippet>223</a> }
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">let </span>length = <span class="self">self</span>.len();
<a href=#227 id=227 data-nosnippet>227</a> write_remaining_length(buffer, length)<span class="question-mark">?</span>;
<a href=#228 id=228 data-nosnippet>228</a>
<a href=#229 id=229 data-nosnippet>229</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(session_expiry_interval) = <span class="self">self</span>.session_expiry_interval {
<a href=#230 id=230 data-nosnippet>230</a> buffer.put_u8(PropertyType::SessionExpiryInterval <span class="kw">as </span>u8);
<a href=#231 id=231 data-nosnippet>231</a> buffer.put_u32(session_expiry_interval);
<a href=#232 id=232 data-nosnippet>232</a> }
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#235 id=235 data-nosnippet>235</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#236 id=236 data-nosnippet>236</a> write_mqtt_string(buffer, reason);
<a href=#237 id=237 data-nosnippet>237</a> }
<a href=#238 id=238 data-nosnippet>238</a>
<a href=#239 id=239 data-nosnippet>239</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#240 id=240 data-nosnippet>240</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#241 id=241 data-nosnippet>241</a> write_mqtt_string(buffer, key);
<a href=#242 id=242 data-nosnippet>242</a> write_mqtt_string(buffer, value);
<a href=#243 id=243 data-nosnippet>243</a> }
<a href=#244 id=244 data-nosnippet>244</a>
<a href=#245 id=245 data-nosnippet>245</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reference) = <span class="kw-2">&amp;</span><span class="self">self</span>.server_reference {
<a href=#246 id=246 data-nosnippet>246</a> buffer.put_u8(PropertyType::ServerReference <span class="kw">as </span>u8);
<a href=#247 id=247 data-nosnippet>247</a> write_mqtt_string(buffer, reference);
<a href=#248 id=248 data-nosnippet>248</a> }
<a href=#249 id=249 data-nosnippet>249</a>
<a href=#250 id=250 data-nosnippet>250</a> <span class="prelude-val">Ok</span>(())
<a href=#251 id=251 data-nosnippet>251</a> }
<a href=#252 id=252 data-nosnippet>252</a>}
<a href=#253 id=253 data-nosnippet>253</a>
<a href=#254 id=254 data-nosnippet>254</a><span class="kw">impl </span>Disconnect {
<a href=#255 id=255 data-nosnippet>255</a> <span class="kw">pub fn </span>new(reason: DisconnectReasonCode) -&gt; <span class="self">Self </span>{
<a href=#256 id=256 data-nosnippet>256</a> <span class="self">Self </span>{
<a href=#257 id=257 data-nosnippet>257</a> reason_code: reason,
<a href=#258 id=258 data-nosnippet>258</a> properties: <span class="prelude-val">None</span>,
<a href=#259 id=259 data-nosnippet>259</a> }
<a href=#260 id=260 data-nosnippet>260</a> }
<a href=#261 id=261 data-nosnippet>261</a>
<a href=#262 id=262 data-nosnippet>262</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#263 id=263 data-nosnippet>263</a> <span class="kw">if </span><span class="self">self</span>.reason_code == DisconnectReasonCode::NormalDisconnection
<a href=#264 id=264 data-nosnippet>264</a> &amp;&amp; <span class="self">self</span>.properties.is_none()
<a href=#265 id=265 data-nosnippet>265</a> {
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">return </span><span class="number">2</span>; <span class="comment">// Packet type + 0x00
<a href=#267 id=267 data-nosnippet>267</a> </span>}
<a href=#268 id=268 data-nosnippet>268</a>
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">let </span><span class="kw-2">mut </span>length = <span class="number">0</span>;
<a href=#270 id=270 data-nosnippet>270</a>
<a href=#271 id=271 data-nosnippet>271</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(properties) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#272 id=272 data-nosnippet>272</a> length += <span class="number">1</span>; <span class="comment">// Disconnect Reason Code
<a href=#273 id=273 data-nosnippet>273</a>
<a href=#274 id=274 data-nosnippet>274</a> </span><span class="kw">let </span>properties_len = properties.len();
<a href=#275 id=275 data-nosnippet>275</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#276 id=276 data-nosnippet>276</a> length += properties_len_len + properties_len;
<a href=#277 id=277 data-nosnippet>277</a> } <span class="kw">else </span>{
<a href=#278 id=278 data-nosnippet>278</a> length += <span class="number">1</span>;
<a href=#279 id=279 data-nosnippet>279</a> }
<a href=#280 id=280 data-nosnippet>280</a>
<a href=#281 id=281 data-nosnippet>281</a> length
<a href=#282 id=282 data-nosnippet>282</a> }
<a href=#283 id=283 data-nosnippet>283</a>
<a href=#284 id=284 data-nosnippet>284</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#285 id=285 data-nosnippet>285</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#286 id=286 data-nosnippet>286</a> <span class="kw">if </span>len == <span class="number">2 </span>{
<a href=#287 id=287 data-nosnippet>287</a> <span class="kw">return </span>len;
<a href=#288 id=288 data-nosnippet>288</a> }
<a href=#289 id=289 data-nosnippet>289</a>
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#291 id=291 data-nosnippet>291</a>
<a href=#292 id=292 data-nosnippet>292</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#293 id=293 data-nosnippet>293</a> }
<a href=#294 id=294 data-nosnippet>294</a>
<a href=#295 id=295 data-nosnippet>295</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, Error&gt; {
<a href=#296 id=296 data-nosnippet>296</a> <span class="kw">let </span>packet_type = fixed_header.byte1 &gt;&gt; <span class="number">4</span>;
<a href=#297 id=297 data-nosnippet>297</a> <span class="kw">let </span>flags = fixed_header.byte1 &amp; <span class="number">0b0000_1111</span>;
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a> bytes.advance(fixed_header.fixed_header_len);
<a href=#300 id=300 data-nosnippet>300</a>
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">if </span>packet_type != PacketType::Disconnect <span class="kw">as </span>u8 {
<a href=#302 id=302 data-nosnippet>302</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPacketType(packet_type));
<a href=#303 id=303 data-nosnippet>303</a> };
<a href=#304 id=304 data-nosnippet>304</a>
<a href=#305 id=305 data-nosnippet>305</a> <span class="kw">if </span>flags != <span class="number">0x00 </span>{
<a href=#306 id=306 data-nosnippet>306</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#307 id=307 data-nosnippet>307</a> };
<a href=#308 id=308 data-nosnippet>308</a>
<a href=#309 id=309 data-nosnippet>309</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">0 </span>{
<a href=#310 id=310 data-nosnippet>310</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="self">Self</span>::new(DisconnectReasonCode::NormalDisconnection));
<a href=#311 id=311 data-nosnippet>311</a> }
<a href=#312 id=312 data-nosnippet>312</a>
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">let </span>reason_code = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#314 id=314 data-nosnippet>314</a>
<a href=#315 id=315 data-nosnippet>315</a> <span class="kw">let </span>disconnect = <span class="self">Self </span>{
<a href=#316 id=316 data-nosnippet>316</a> reason_code: reason_code.try_into()<span class="question-mark">?</span>,
<a href=#317 id=317 data-nosnippet>317</a> properties: DisconnectProperties::extract(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>,
<a href=#318 id=318 data-nosnippet>318</a> };
<a href=#319 id=319 data-nosnippet>319</a>
<a href=#320 id=320 data-nosnippet>320</a> <span class="prelude-val">Ok</span>(disconnect)
<a href=#321 id=321 data-nosnippet>321</a> }
<a href=#322 id=322 data-nosnippet>322</a>
<a href=#323 id=323 data-nosnippet>323</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#324 id=324 data-nosnippet>324</a> buffer.put_u8(<span class="number">0xE0</span>);
<a href=#325 id=325 data-nosnippet>325</a>
<a href=#326 id=326 data-nosnippet>326</a> <span class="kw">let </span>length = <span class="self">self</span>.len();
<a href=#327 id=327 data-nosnippet>327</a>
<a href=#328 id=328 data-nosnippet>328</a> <span class="kw">if </span>length == <span class="number">2 </span>{
<a href=#329 id=329 data-nosnippet>329</a> buffer.put_u8(<span class="number">0x00</span>);
<a href=#330 id=330 data-nosnippet>330</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(length);
<a href=#331 id=331 data-nosnippet>331</a> }
<a href=#332 id=332 data-nosnippet>332</a>
<a href=#333 id=333 data-nosnippet>333</a> <span class="kw">let </span>len_len = write_remaining_length(buffer, length)<span class="question-mark">?</span>;
<a href=#334 id=334 data-nosnippet>334</a>
<a href=#335 id=335 data-nosnippet>335</a> buffer.put_u8(<span class="self">self</span>.reason_code <span class="kw">as </span>u8);
<a href=#336 id=336 data-nosnippet>336</a>
<a href=#337 id=337 data-nosnippet>337</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(properties) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#338 id=338 data-nosnippet>338</a> properties.write(buffer)<span class="question-mark">?</span>;
<a href=#339 id=339 data-nosnippet>339</a> } <span class="kw">else </span>{
<a href=#340 id=340 data-nosnippet>340</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#341 id=341 data-nosnippet>341</a> }
<a href=#342 id=342 data-nosnippet>342</a>
<a href=#343 id=343 data-nosnippet>343</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ len_len + length)
<a href=#344 id=344 data-nosnippet>344</a> }
<a href=#345 id=345 data-nosnippet>345</a>}
<a href=#346 id=346 data-nosnippet>346</a>
<a href=#347 id=347 data-nosnippet>347</a><span class="attr">#[cfg(test)]
<a href=#348 id=348 data-nosnippet>348</a></span><span class="kw">mod </span>test {
<a href=#349 id=349 data-nosnippet>349</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#350 id=350 data-nosnippet>350</a>
<a href=#351 id=351 data-nosnippet>351</a> <span class="kw">use </span><span class="kw">super</span>::parse_fixed_header;
<a href=#352 id=352 data-nosnippet>352</a>
<a href=#353 id=353 data-nosnippet>353</a> <span class="kw">use super</span>::{Disconnect, DisconnectProperties, DisconnectReasonCode};
<a href=#354 id=354 data-nosnippet>354</a>
<a href=#355 id=355 data-nosnippet>355</a> <span class="attr">#[test]
<a href=#356 id=356 data-nosnippet>356</a> </span><span class="kw">fn </span>disconnect1_parsing_works() {
<a href=#357 id=357 data-nosnippet>357</a> <span class="kw">let </span><span class="kw-2">mut </span>buffer = bytes::BytesMut::new();
<a href=#358 id=358 data-nosnippet>358</a> <span class="kw">let </span>packet_bytes = [
<a href=#359 id=359 data-nosnippet>359</a> <span class="number">0xE0</span>, <span class="comment">// Packet type
<a href=#360 id=360 data-nosnippet>360</a> </span><span class="number">0x00</span>, <span class="comment">// Remaining length
<a href=#361 id=361 data-nosnippet>361</a> </span>];
<a href=#362 id=362 data-nosnippet>362</a> <span class="kw">let </span>expected = Disconnect::new(DisconnectReasonCode::NormalDisconnection);
<a href=#363 id=363 data-nosnippet>363</a>
<a href=#364 id=364 data-nosnippet>364</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span>packet_bytes[..]);
<a href=#365 id=365 data-nosnippet>365</a>
<a href=#366 id=366 data-nosnippet>366</a> <span class="kw">let </span>fixed_header = parse_fixed_header(buffer.iter()).unwrap();
<a href=#367 id=367 data-nosnippet>367</a> <span class="kw">let </span>disconnect_bytes = buffer.split_to(fixed_header.frame_length()).freeze();
<a href=#368 id=368 data-nosnippet>368</a> <span class="kw">let </span>disconnect = Disconnect::read(fixed_header, disconnect_bytes).unwrap();
<a href=#369 id=369 data-nosnippet>369</a>
<a href=#370 id=370 data-nosnippet>370</a> <span class="macro">assert_eq!</span>(disconnect, expected);
<a href=#371 id=371 data-nosnippet>371</a> }
<a href=#372 id=372 data-nosnippet>372</a>
<a href=#373 id=373 data-nosnippet>373</a> <span class="attr">#[test]
<a href=#374 id=374 data-nosnippet>374</a> </span><span class="kw">fn </span>disconnect1_encoding_works() {
<a href=#375 id=375 data-nosnippet>375</a> <span class="kw">let </span><span class="kw-2">mut </span>buffer = BytesMut::new();
<a href=#376 id=376 data-nosnippet>376</a> <span class="kw">let </span>disconnect = Disconnect::new(DisconnectReasonCode::NormalDisconnection);
<a href=#377 id=377 data-nosnippet>377</a> <span class="kw">let </span>expected = [
<a href=#378 id=378 data-nosnippet>378</a> <span class="number">0xE0</span>, <span class="comment">// Packet type
<a href=#379 id=379 data-nosnippet>379</a> </span><span class="number">0x00</span>, <span class="comment">// Remaining length
<a href=#380 id=380 data-nosnippet>380</a> </span>];
<a href=#381 id=381 data-nosnippet>381</a>
<a href=#382 id=382 data-nosnippet>382</a> disconnect.write(<span class="kw-2">&amp;mut </span>buffer).unwrap();
<a href=#383 id=383 data-nosnippet>383</a>
<a href=#384 id=384 data-nosnippet>384</a> <span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buffer[..], <span class="kw-2">&amp;</span>expected);
<a href=#385 id=385 data-nosnippet>385</a> }
<a href=#386 id=386 data-nosnippet>386</a>
<a href=#387 id=387 data-nosnippet>387</a> <span class="kw">fn </span>sample2() -&gt; Disconnect {
<a href=#388 id=388 data-nosnippet>388</a> <span class="kw">let </span>properties = DisconnectProperties {
<a href=#389 id=389 data-nosnippet>389</a> <span class="comment">// TODO: change to 2137 xD
<a href=#390 id=390 data-nosnippet>390</a> </span>session_expiry_interval: <span class="prelude-val">Some</span>(<span class="number">1234</span>),
<a href=#391 id=391 data-nosnippet>391</a> reason_string: <span class="prelude-val">Some</span>(<span class="string">"test"</span>.to_owned()),
<a href=#392 id=392 data-nosnippet>392</a> user_properties: <span class="macro">vec!</span>[(<span class="string">"test"</span>.to_owned(), <span class="string">"test"</span>.to_owned())],
<a href=#393 id=393 data-nosnippet>393</a> server_reference: <span class="prelude-val">Some</span>(<span class="string">"test"</span>.to_owned()),
<a href=#394 id=394 data-nosnippet>394</a> };
<a href=#395 id=395 data-nosnippet>395</a>
<a href=#396 id=396 data-nosnippet>396</a> Disconnect {
<a href=#397 id=397 data-nosnippet>397</a> reason_code: DisconnectReasonCode::UnspecifiedError,
<a href=#398 id=398 data-nosnippet>398</a> properties: <span class="prelude-val">Some</span>(properties),
<a href=#399 id=399 data-nosnippet>399</a> }
<a href=#400 id=400 data-nosnippet>400</a> }
<a href=#401 id=401 data-nosnippet>401</a>
<a href=#402 id=402 data-nosnippet>402</a> <span class="kw">fn </span>sample_bytes2() -&gt; Vec&lt;u8&gt; {
<a href=#403 id=403 data-nosnippet>403</a> <span class="macro">vec!</span>[
<a href=#404 id=404 data-nosnippet>404</a> <span class="number">0xE0</span>, <span class="comment">// Packet type
<a href=#405 id=405 data-nosnippet>405</a> </span><span class="number">0x22</span>, <span class="comment">// Remaining length
<a href=#406 id=406 data-nosnippet>406</a> </span><span class="number">0x80</span>, <span class="comment">// Disconnect Reason Code
<a href=#407 id=407 data-nosnippet>407</a> </span><span class="number">0x20</span>, <span class="comment">// Properties length
<a href=#408 id=408 data-nosnippet>408</a> </span><span class="number">0x11</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x04</span>, <span class="number">0xd2</span>, <span class="comment">// Session expiry interval
<a href=#409 id=409 data-nosnippet>409</a> </span><span class="number">0x1F</span>, <span class="number">0x00</span>, <span class="number">0x04</span>, <span class="number">0x74</span>, <span class="number">0x65</span>, <span class="number">0x73</span>, <span class="number">0x74</span>, <span class="comment">// Reason string
<a href=#410 id=410 data-nosnippet>410</a> </span><span class="number">0x26</span>, <span class="number">0x00</span>, <span class="number">0x04</span>, <span class="number">0x74</span>, <span class="number">0x65</span>, <span class="number">0x73</span>, <span class="number">0x74</span>, <span class="number">0x00</span>, <span class="number">0x04</span>, <span class="number">0x74</span>, <span class="number">0x65</span>, <span class="number">0x73</span>,
<a href=#411 id=411 data-nosnippet>411</a> <span class="number">0x74</span>, <span class="comment">// User properties
<a href=#412 id=412 data-nosnippet>412</a> </span><span class="number">0x1C</span>, <span class="number">0x00</span>, <span class="number">0x04</span>, <span class="number">0x74</span>, <span class="number">0x65</span>, <span class="number">0x73</span>, <span class="number">0x74</span>, <span class="comment">// server reference
<a href=#413 id=413 data-nosnippet>413</a> </span>]
<a href=#414 id=414 data-nosnippet>414</a> }
<a href=#415 id=415 data-nosnippet>415</a>
<a href=#416 id=416 data-nosnippet>416</a> <span class="attr">#[test]
<a href=#417 id=417 data-nosnippet>417</a> </span><span class="kw">fn </span>disconnect2_parsing_works() {
<a href=#418 id=418 data-nosnippet>418</a> <span class="kw">let </span><span class="kw-2">mut </span>buffer = bytes::BytesMut::new();
<a href=#419 id=419 data-nosnippet>419</a> <span class="kw">let </span>packet_bytes = sample_bytes2();
<a href=#420 id=420 data-nosnippet>420</a> <span class="kw">let </span>expected = sample2();
<a href=#421 id=421 data-nosnippet>421</a>
<a href=#422 id=422 data-nosnippet>422</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span>packet_bytes[..]);
<a href=#423 id=423 data-nosnippet>423</a>
<a href=#424 id=424 data-nosnippet>424</a> <span class="kw">let </span>fixed_header = parse_fixed_header(buffer.iter()).unwrap();
<a href=#425 id=425 data-nosnippet>425</a> <span class="kw">let </span>disconnect_bytes = buffer.split_to(fixed_header.frame_length()).freeze();
<a href=#426 id=426 data-nosnippet>426</a> <span class="kw">let </span>disconnect = Disconnect::read(fixed_header, disconnect_bytes).unwrap();
<a href=#427 id=427 data-nosnippet>427</a>
<a href=#428 id=428 data-nosnippet>428</a> <span class="macro">assert_eq!</span>(disconnect, expected);
<a href=#429 id=429 data-nosnippet>429</a> }
<a href=#430 id=430 data-nosnippet>430</a>
<a href=#431 id=431 data-nosnippet>431</a> <span class="attr">#[test]
<a href=#432 id=432 data-nosnippet>432</a> </span><span class="kw">fn </span>disconnect2_encoding_works() {
<a href=#433 id=433 data-nosnippet>433</a> <span class="kw">let </span><span class="kw-2">mut </span>buffer = BytesMut::new();
<a href=#434 id=434 data-nosnippet>434</a>
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">let </span>disconnect = sample2();
<a href=#436 id=436 data-nosnippet>436</a> <span class="kw">let </span>expected = sample_bytes2();
<a href=#437 id=437 data-nosnippet>437</a>
<a href=#438 id=438 data-nosnippet>438</a> disconnect.write(<span class="kw-2">&amp;mut </span>buffer).unwrap();
<a href=#439 id=439 data-nosnippet>439</a>
<a href=#440 id=440 data-nosnippet>440</a> <span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>buffer[..], <span class="kw-2">&amp;</span>expected);
<a href=#441 id=441 data-nosnippet>441</a> }
<a href=#442 id=442 data-nosnippet>442</a>
<a href=#443 id=443 data-nosnippet>443</a> <span class="comment">// use super::*;
<a href=#444 id=444 data-nosnippet>444</a> </span><span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#445 id=445 data-nosnippet>445</a> <span class="comment">// use bytes::BytesMut;
<a href=#446 id=446 data-nosnippet>446</a> </span><span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#447 id=447 data-nosnippet>447</a>
<a href=#448 id=448 data-nosnippet>448</a> <span class="attr">#[test]
<a href=#449 id=449 data-nosnippet>449</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#450 id=450 data-nosnippet>450</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#451 id=451 data-nosnippet>451</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#452 id=452 data-nosnippet>452</a> // remaining_length field in the packet be 2 bytes long.
<a href=#453 id=453 data-nosnippet>453</a> </span><span class="kw">let </span>disconn_props = DisconnectProperties {
<a href=#454 id=454 data-nosnippet>454</a> session_expiry_interval: <span class="prelude-val">None</span>,
<a href=#455 id=455 data-nosnippet>455</a> reason_string: <span class="prelude-val">None</span>,
<a href=#456 id=456 data-nosnippet>456</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#457 id=457 data-nosnippet>457</a> server_reference: <span class="prelude-val">None</span>,
<a href=#458 id=458 data-nosnippet>458</a> };
<a href=#459 id=459 data-nosnippet>459</a>
<a href=#460 id=460 data-nosnippet>460</a> <span class="kw">let </span><span class="kw-2">mut </span>disconn_pkt = Disconnect::new(DisconnectReasonCode::NormalDisconnection);
<a href=#461 id=461 data-nosnippet>461</a> disconn_pkt.properties = <span class="prelude-val">Some</span>(disconn_props);
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a> <span class="kw">let </span>size_from_size = disconn_pkt.size();
<a href=#464 id=464 data-nosnippet>464</a> <span class="kw">let </span>size_from_write = disconn_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#465 id=465 data-nosnippet>465</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#466 id=466 data-nosnippet>466</a>
<a href=#467 id=467 data-nosnippet>467</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#468 id=468 data-nosnippet>468</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#469 id=469 data-nosnippet>469</a> }
<a href=#470 id=470 data-nosnippet>470</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,495 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::slice::Iter;
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">pub use </span><span class="self">self</span>::{
<a href=#4 id=4 data-nosnippet>4</a> connack::{ConnAck, ConnAckProperties, ConnectReturnCode},
<a href=#5 id=5 data-nosnippet>5</a> connect::{Connect, ConnectProperties, LastWill, LastWillProperties, Login},
<a href=#6 id=6 data-nosnippet>6</a> disconnect::{Disconnect, DisconnectReasonCode},
<a href=#7 id=7 data-nosnippet>7</a> ping::{PingReq, PingResp},
<a href=#8 id=8 data-nosnippet>8</a> puback::{PubAck, PubAckProperties, PubAckReason},
<a href=#9 id=9 data-nosnippet>9</a> pubcomp::{PubComp, PubCompProperties, PubCompReason},
<a href=#10 id=10 data-nosnippet>10</a> publish::{Publish, PublishProperties},
<a href=#11 id=11 data-nosnippet>11</a> pubrec::{PubRec, PubRecProperties, PubRecReason},
<a href=#12 id=12 data-nosnippet>12</a> pubrel::{PubRel, PubRelProperties, PubRelReason},
<a href=#13 id=13 data-nosnippet>13</a> suback::{SubAck, SubAckProperties, SubscribeReasonCode},
<a href=#14 id=14 data-nosnippet>14</a> subscribe::{Filter, RetainForwardRule, Subscribe, SubscribeProperties},
<a href=#15 id=15 data-nosnippet>15</a> unsuback::{UnsubAck, UnsubAckProperties, UnsubAckReason},
<a href=#16 id=16 data-nosnippet>16</a> unsubscribe::{Unsubscribe, UnsubscribeProperties},
<a href=#17 id=17 data-nosnippet>17</a>};
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">mod </span>connack;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">mod </span>connect;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">mod </span>disconnect;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">mod </span>ping;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">mod </span>puback;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">mod </span>pubcomp;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">mod </span>publish;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">mod </span>pubrec;
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">mod </span>pubrel;
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">mod </span>suback;
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">mod </span>subscribe;
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">mod </span>unsuback;
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">mod </span>unsubscribe;
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[derive(Clone, Debug, PartialEq, Eq)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub enum </span>Packet {
<a href=#38 id=38 data-nosnippet>38</a> Connect(Connect, <span class="prelude-ty">Option</span>&lt;LastWill&gt;, <span class="prelude-ty">Option</span>&lt;Login&gt;),
<a href=#39 id=39 data-nosnippet>39</a> ConnAck(ConnAck),
<a href=#40 id=40 data-nosnippet>40</a> Publish(Publish),
<a href=#41 id=41 data-nosnippet>41</a> PubAck(PubAck),
<a href=#42 id=42 data-nosnippet>42</a> PingReq(PingReq),
<a href=#43 id=43 data-nosnippet>43</a> PingResp(PingResp),
<a href=#44 id=44 data-nosnippet>44</a> Subscribe(Subscribe),
<a href=#45 id=45 data-nosnippet>45</a> SubAck(SubAck),
<a href=#46 id=46 data-nosnippet>46</a> PubRec(PubRec),
<a href=#47 id=47 data-nosnippet>47</a> PubRel(PubRel),
<a href=#48 id=48 data-nosnippet>48</a> PubComp(PubComp),
<a href=#49 id=49 data-nosnippet>49</a> Unsubscribe(Unsubscribe),
<a href=#50 id=50 data-nosnippet>50</a> UnsubAck(UnsubAck),
<a href=#51 id=51 data-nosnippet>51</a> Disconnect(Disconnect),
<a href=#52 id=52 data-nosnippet>52</a>}
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a><span class="kw">impl </span>Packet {
<a href=#55 id=55 data-nosnippet>55</a> <span class="doccomment">/// Reads a stream of bytes and extracts next MQTT packet out of it
<a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">pub fn </span>read(stream: <span class="kw-2">&amp;mut </span>BytesMut, max_size: <span class="prelude-ty">Option</span>&lt;usize&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;Packet, Error&gt; {
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span>fixed_header = check(stream.iter(), max_size)<span class="question-mark">?</span>;
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> <span class="comment">// Test with a stream with exactly the size to check border panics
<a href=#60 id=60 data-nosnippet>60</a> </span><span class="kw">let </span>packet = stream.split_to(fixed_header.frame_length());
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>packet_type = fixed_header.packet_type()<span class="question-mark">?</span>;
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">0 </span>{
<a href=#64 id=64 data-nosnippet>64</a> <span class="comment">// no payload packets, Disconnect still has a bit more info
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">return match </span>packet_type {
<a href=#66 id=66 data-nosnippet>66</a> PacketType::PingReq =&gt; <span class="prelude-val">Ok</span>(Packet::PingReq(PingReq)),
<a href=#67 id=67 data-nosnippet>67</a> PacketType::PingResp =&gt; <span class="prelude-val">Ok</span>(Packet::PingResp(PingResp)),
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(Error::PayloadRequired),
<a href=#69 id=69 data-nosnippet>69</a> };
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>packet = packet.freeze();
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>packet = <span class="kw">match </span>packet_type {
<a href=#74 id=74 data-nosnippet>74</a> PacketType::Connect =&gt; {
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>(connect, will, login) = Connect::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#76 id=76 data-nosnippet>76</a> Packet::Connect(connect, will, login)
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a> PacketType::Publish =&gt; {
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">let </span>publish = Publish::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#80 id=80 data-nosnippet>80</a> Packet::Publish(publish)
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a> PacketType::Subscribe =&gt; {
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>subscribe = Subscribe::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a> Packet::Subscribe(subscribe)
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a> PacketType::Unsubscribe =&gt; {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span>unsubscribe = Unsubscribe::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#88 id=88 data-nosnippet>88</a> Packet::Unsubscribe(unsubscribe)
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a> PacketType::ConnAck =&gt; {
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">let </span>connack = ConnAck::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#92 id=92 data-nosnippet>92</a> Packet::ConnAck(connack)
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a> PacketType::PubAck =&gt; {
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span>puback = PubAck::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#96 id=96 data-nosnippet>96</a> Packet::PubAck(puback)
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a> PacketType::PubRec =&gt; {
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">let </span>pubrec = PubRec::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#100 id=100 data-nosnippet>100</a> Packet::PubRec(pubrec)
<a href=#101 id=101 data-nosnippet>101</a> }
<a href=#102 id=102 data-nosnippet>102</a> PacketType::PubRel =&gt; {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>pubrel = PubRel::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#104 id=104 data-nosnippet>104</a> Packet::PubRel(pubrel)
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a> PacketType::PubComp =&gt; {
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">let </span>pubcomp = PubComp::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#108 id=108 data-nosnippet>108</a> Packet::PubComp(pubcomp)
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a> PacketType::SubAck =&gt; {
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">let </span>suback = SubAck::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#112 id=112 data-nosnippet>112</a> Packet::SubAck(suback)
<a href=#113 id=113 data-nosnippet>113</a> }
<a href=#114 id=114 data-nosnippet>114</a> PacketType::UnsubAck =&gt; {
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">let </span>unsuback = UnsubAck::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#116 id=116 data-nosnippet>116</a> Packet::UnsubAck(unsuback)
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a> PacketType::PingReq =&gt; Packet::PingReq(PingReq),
<a href=#119 id=119 data-nosnippet>119</a> PacketType::PingResp =&gt; Packet::PingResp(PingResp),
<a href=#120 id=120 data-nosnippet>120</a> PacketType::Disconnect =&gt; {
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">let </span>disconnect = Disconnect::read(fixed_header, packet)<span class="question-mark">?</span>;
<a href=#122 id=122 data-nosnippet>122</a> Packet::Disconnect(disconnect)
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a> };
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a> <span class="prelude-val">Ok</span>(packet)
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, write: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#131 id=131 data-nosnippet>131</a> <span class="self">Self</span>::Publish(publish) =&gt; publish.write(write),
<a href=#132 id=132 data-nosnippet>132</a> <span class="self">Self</span>::Subscribe(subscription) =&gt; subscription.write(write),
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">Self</span>::Unsubscribe(unsubscribe) =&gt; unsubscribe.write(write),
<a href=#134 id=134 data-nosnippet>134</a> <span class="self">Self</span>::ConnAck(ack) =&gt; ack.write(write),
<a href=#135 id=135 data-nosnippet>135</a> <span class="self">Self</span>::PubAck(ack) =&gt; ack.write(write),
<a href=#136 id=136 data-nosnippet>136</a> <span class="self">Self</span>::SubAck(ack) =&gt; ack.write(write),
<a href=#137 id=137 data-nosnippet>137</a> <span class="self">Self</span>::UnsubAck(unsuback) =&gt; unsuback.write(write),
<a href=#138 id=138 data-nosnippet>138</a> <span class="self">Self</span>::PubRec(pubrec) =&gt; pubrec.write(write),
<a href=#139 id=139 data-nosnippet>139</a> <span class="self">Self</span>::PubRel(pubrel) =&gt; pubrel.write(write),
<a href=#140 id=140 data-nosnippet>140</a> <span class="self">Self</span>::PubComp(pubcomp) =&gt; pubcomp.write(write),
<a href=#141 id=141 data-nosnippet>141</a> <span class="self">Self</span>::Connect(connect, will, login) =&gt; connect.write(will, login, write),
<a href=#142 id=142 data-nosnippet>142</a> <span class="self">Self</span>::PingReq(<span class="kw">_</span>) =&gt; PingReq::write(write),
<a href=#143 id=143 data-nosnippet>143</a> <span class="self">Self</span>::PingResp(<span class="kw">_</span>) =&gt; PingResp::write(write),
<a href=#144 id=144 data-nosnippet>144</a> <span class="self">Self</span>::Disconnect(disconnect) =&gt; disconnect.write(write),
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a> }
<a href=#147 id=147 data-nosnippet>147</a>}
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a><span class="doccomment">/// MQTT packet type
<a href=#150 id=150 data-nosnippet>150</a></span><span class="attr">#[repr(u8)]
<a href=#151 id=151 data-nosnippet>151</a>#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#152 id=152 data-nosnippet>152</a></span><span class="kw">pub enum </span>PacketType {
<a href=#153 id=153 data-nosnippet>153</a> Connect = <span class="number">1</span>,
<a href=#154 id=154 data-nosnippet>154</a> ConnAck,
<a href=#155 id=155 data-nosnippet>155</a> Publish,
<a href=#156 id=156 data-nosnippet>156</a> PubAck,
<a href=#157 id=157 data-nosnippet>157</a> PubRec,
<a href=#158 id=158 data-nosnippet>158</a> PubRel,
<a href=#159 id=159 data-nosnippet>159</a> PubComp,
<a href=#160 id=160 data-nosnippet>160</a> Subscribe,
<a href=#161 id=161 data-nosnippet>161</a> SubAck,
<a href=#162 id=162 data-nosnippet>162</a> Unsubscribe,
<a href=#163 id=163 data-nosnippet>163</a> UnsubAck,
<a href=#164 id=164 data-nosnippet>164</a> PingReq,
<a href=#165 id=165 data-nosnippet>165</a> PingResp,
<a href=#166 id=166 data-nosnippet>166</a> Disconnect,
<a href=#167 id=167 data-nosnippet>167</a>}
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a><span class="attr">#[repr(u8)]
<a href=#170 id=170 data-nosnippet>170</a>#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#171 id=171 data-nosnippet>171</a></span><span class="kw">enum </span>PropertyType {
<a href=#172 id=172 data-nosnippet>172</a> PayloadFormatIndicator = <span class="number">1</span>,
<a href=#173 id=173 data-nosnippet>173</a> MessageExpiryInterval = <span class="number">2</span>,
<a href=#174 id=174 data-nosnippet>174</a> ContentType = <span class="number">3</span>,
<a href=#175 id=175 data-nosnippet>175</a> ResponseTopic = <span class="number">8</span>,
<a href=#176 id=176 data-nosnippet>176</a> CorrelationData = <span class="number">9</span>,
<a href=#177 id=177 data-nosnippet>177</a> SubscriptionIdentifier = <span class="number">11</span>,
<a href=#178 id=178 data-nosnippet>178</a> SessionExpiryInterval = <span class="number">17</span>,
<a href=#179 id=179 data-nosnippet>179</a> AssignedClientIdentifier = <span class="number">18</span>,
<a href=#180 id=180 data-nosnippet>180</a> ServerKeepAlive = <span class="number">19</span>,
<a href=#181 id=181 data-nosnippet>181</a> AuthenticationMethod = <span class="number">21</span>,
<a href=#182 id=182 data-nosnippet>182</a> AuthenticationData = <span class="number">22</span>,
<a href=#183 id=183 data-nosnippet>183</a> RequestProblemInformation = <span class="number">23</span>,
<a href=#184 id=184 data-nosnippet>184</a> WillDelayInterval = <span class="number">24</span>,
<a href=#185 id=185 data-nosnippet>185</a> RequestResponseInformation = <span class="number">25</span>,
<a href=#186 id=186 data-nosnippet>186</a> ResponseInformation = <span class="number">26</span>,
<a href=#187 id=187 data-nosnippet>187</a> ServerReference = <span class="number">28</span>,
<a href=#188 id=188 data-nosnippet>188</a> ReasonString = <span class="number">31</span>,
<a href=#189 id=189 data-nosnippet>189</a> ReceiveMaximum = <span class="number">33</span>,
<a href=#190 id=190 data-nosnippet>190</a> TopicAliasMaximum = <span class="number">34</span>,
<a href=#191 id=191 data-nosnippet>191</a> TopicAlias = <span class="number">35</span>,
<a href=#192 id=192 data-nosnippet>192</a> MaximumQos = <span class="number">36</span>,
<a href=#193 id=193 data-nosnippet>193</a> RetainAvailable = <span class="number">37</span>,
<a href=#194 id=194 data-nosnippet>194</a> UserProperty = <span class="number">38</span>,
<a href=#195 id=195 data-nosnippet>195</a> MaximumPacketSize = <span class="number">39</span>,
<a href=#196 id=196 data-nosnippet>196</a> WildcardSubscriptionAvailable = <span class="number">40</span>,
<a href=#197 id=197 data-nosnippet>197</a> SubscriptionIdentifierAvailable = <span class="number">41</span>,
<a href=#198 id=198 data-nosnippet>198</a> SharedSubscriptionAvailable = <span class="number">42</span>,
<a href=#199 id=199 data-nosnippet>199</a>}
<a href=#200 id=200 data-nosnippet>200</a>
<a href=#201 id=201 data-nosnippet>201</a><span class="doccomment">/// Packet type from a byte
<a href=#202 id=202 data-nosnippet>202</a>///
<a href=#203 id=203 data-nosnippet>203</a>/// ```ignore
<a href=#204 id=204 data-nosnippet>204</a>/// 7 3 0
<a href=#205 id=205 data-nosnippet>205</a>/// +--------------------------+--------------------------+
<a href=#206 id=206 data-nosnippet>206</a>/// byte 1 | MQTT Control Packet Type | Flags for each type |
<a href=#207 id=207 data-nosnippet>207</a>/// +--------------------------+--------------------------+
<a href=#208 id=208 data-nosnippet>208</a>/// | Remaining Bytes Len (1/2/3/4 bytes) |
<a href=#209 id=209 data-nosnippet>209</a>/// +-----------------------------------------------------+
<a href=#210 id=210 data-nosnippet>210</a>///
<a href=#211 id=211 data-nosnippet>211</a>/// &lt;https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207&gt;
<a href=#212 id=212 data-nosnippet>212</a>/// ```
<a href=#213 id=213 data-nosnippet>213</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
<a href=#214 id=214 data-nosnippet>214</a></span><span class="kw">pub struct </span>FixedHeader {
<a href=#215 id=215 data-nosnippet>215</a> <span class="doccomment">/// First byte of the stream. Used to identify packet types and
<a href=#216 id=216 data-nosnippet>216</a> /// several flags
<a href=#217 id=217 data-nosnippet>217</a> </span>byte1: u8,
<a href=#218 id=218 data-nosnippet>218</a> <span class="doccomment">/// Length of fixed header. Byte 1 + (1..4) bytes. So fixed header
<a href=#219 id=219 data-nosnippet>219</a> /// len can vary from 2 bytes to 5 bytes
<a href=#220 id=220 data-nosnippet>220</a> /// 1..4 bytes are variable length encoded to represent remaining length
<a href=#221 id=221 data-nosnippet>221</a> </span>fixed_header_len: usize,
<a href=#222 id=222 data-nosnippet>222</a> <span class="doccomment">/// Remaining length of the packet. Doesn't include fixed header bytes
<a href=#223 id=223 data-nosnippet>223</a> /// Represents variable header + payload size
<a href=#224 id=224 data-nosnippet>224</a> </span>remaining_len: usize,
<a href=#225 id=225 data-nosnippet>225</a>}
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a><span class="kw">impl </span>FixedHeader {
<a href=#228 id=228 data-nosnippet>228</a> <span class="kw">pub fn </span>new(byte1: u8, remaining_len_len: usize, remaining_len: usize) -&gt; FixedHeader {
<a href=#229 id=229 data-nosnippet>229</a> FixedHeader {
<a href=#230 id=230 data-nosnippet>230</a> byte1,
<a href=#231 id=231 data-nosnippet>231</a> fixed_header_len: remaining_len_len + <span class="number">1</span>,
<a href=#232 id=232 data-nosnippet>232</a> remaining_len,
<a href=#233 id=233 data-nosnippet>233</a> }
<a href=#234 id=234 data-nosnippet>234</a> }
<a href=#235 id=235 data-nosnippet>235</a>
<a href=#236 id=236 data-nosnippet>236</a> <span class="kw">pub fn </span>packet_type(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;PacketType, Error&gt; {
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">let </span>num = <span class="self">self</span>.byte1 &gt;&gt; <span class="number">4</span>;
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">match </span>num {
<a href=#239 id=239 data-nosnippet>239</a> <span class="number">1 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::Connect),
<a href=#240 id=240 data-nosnippet>240</a> <span class="number">2 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::ConnAck),
<a href=#241 id=241 data-nosnippet>241</a> <span class="number">3 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::Publish),
<a href=#242 id=242 data-nosnippet>242</a> <span class="number">4 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PubAck),
<a href=#243 id=243 data-nosnippet>243</a> <span class="number">5 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PubRec),
<a href=#244 id=244 data-nosnippet>244</a> <span class="number">6 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PubRel),
<a href=#245 id=245 data-nosnippet>245</a> <span class="number">7 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PubComp),
<a href=#246 id=246 data-nosnippet>246</a> <span class="number">8 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::Subscribe),
<a href=#247 id=247 data-nosnippet>247</a> <span class="number">9 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::SubAck),
<a href=#248 id=248 data-nosnippet>248</a> <span class="number">10 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::Unsubscribe),
<a href=#249 id=249 data-nosnippet>249</a> <span class="number">11 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::UnsubAck),
<a href=#250 id=250 data-nosnippet>250</a> <span class="number">12 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PingReq),
<a href=#251 id=251 data-nosnippet>251</a> <span class="number">13 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::PingResp),
<a href=#252 id=252 data-nosnippet>252</a> <span class="number">14 </span>=&gt; <span class="prelude-val">Ok</span>(PacketType::Disconnect),
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(Error::InvalidPacketType(num)),
<a href=#254 id=254 data-nosnippet>254</a> }
<a href=#255 id=255 data-nosnippet>255</a> }
<a href=#256 id=256 data-nosnippet>256</a>
<a href=#257 id=257 data-nosnippet>257</a> <span class="doccomment">/// Returns the size of full packet (fixed header + variable header + payload)
<a href=#258 id=258 data-nosnippet>258</a> /// Fixed header is enough to get the size of a frame in the stream
<a href=#259 id=259 data-nosnippet>259</a> </span><span class="kw">pub fn </span>frame_length(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#260 id=260 data-nosnippet>260</a> <span class="self">self</span>.fixed_header_len + <span class="self">self</span>.remaining_len
<a href=#261 id=261 data-nosnippet>261</a> }
<a href=#262 id=262 data-nosnippet>262</a>}
<a href=#263 id=263 data-nosnippet>263</a>
<a href=#264 id=264 data-nosnippet>264</a><span class="kw">fn </span>property(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;PropertyType, Error&gt; {
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">let </span>property = <span class="kw">match </span>num {
<a href=#266 id=266 data-nosnippet>266</a> <span class="number">1 </span>=&gt; PropertyType::PayloadFormatIndicator,
<a href=#267 id=267 data-nosnippet>267</a> <span class="number">2 </span>=&gt; PropertyType::MessageExpiryInterval,
<a href=#268 id=268 data-nosnippet>268</a> <span class="number">3 </span>=&gt; PropertyType::ContentType,
<a href=#269 id=269 data-nosnippet>269</a> <span class="number">8 </span>=&gt; PropertyType::ResponseTopic,
<a href=#270 id=270 data-nosnippet>270</a> <span class="number">9 </span>=&gt; PropertyType::CorrelationData,
<a href=#271 id=271 data-nosnippet>271</a> <span class="number">11 </span>=&gt; PropertyType::SubscriptionIdentifier,
<a href=#272 id=272 data-nosnippet>272</a> <span class="number">17 </span>=&gt; PropertyType::SessionExpiryInterval,
<a href=#273 id=273 data-nosnippet>273</a> <span class="number">18 </span>=&gt; PropertyType::AssignedClientIdentifier,
<a href=#274 id=274 data-nosnippet>274</a> <span class="number">19 </span>=&gt; PropertyType::ServerKeepAlive,
<a href=#275 id=275 data-nosnippet>275</a> <span class="number">21 </span>=&gt; PropertyType::AuthenticationMethod,
<a href=#276 id=276 data-nosnippet>276</a> <span class="number">22 </span>=&gt; PropertyType::AuthenticationData,
<a href=#277 id=277 data-nosnippet>277</a> <span class="number">23 </span>=&gt; PropertyType::RequestProblemInformation,
<a href=#278 id=278 data-nosnippet>278</a> <span class="number">24 </span>=&gt; PropertyType::WillDelayInterval,
<a href=#279 id=279 data-nosnippet>279</a> <span class="number">25 </span>=&gt; PropertyType::RequestResponseInformation,
<a href=#280 id=280 data-nosnippet>280</a> <span class="number">26 </span>=&gt; PropertyType::ResponseInformation,
<a href=#281 id=281 data-nosnippet>281</a> <span class="number">28 </span>=&gt; PropertyType::ServerReference,
<a href=#282 id=282 data-nosnippet>282</a> <span class="number">31 </span>=&gt; PropertyType::ReasonString,
<a href=#283 id=283 data-nosnippet>283</a> <span class="number">33 </span>=&gt; PropertyType::ReceiveMaximum,
<a href=#284 id=284 data-nosnippet>284</a> <span class="number">34 </span>=&gt; PropertyType::TopicAliasMaximum,
<a href=#285 id=285 data-nosnippet>285</a> <span class="number">35 </span>=&gt; PropertyType::TopicAlias,
<a href=#286 id=286 data-nosnippet>286</a> <span class="number">36 </span>=&gt; PropertyType::MaximumQos,
<a href=#287 id=287 data-nosnippet>287</a> <span class="number">37 </span>=&gt; PropertyType::RetainAvailable,
<a href=#288 id=288 data-nosnippet>288</a> <span class="number">38 </span>=&gt; PropertyType::UserProperty,
<a href=#289 id=289 data-nosnippet>289</a> <span class="number">39 </span>=&gt; PropertyType::MaximumPacketSize,
<a href=#290 id=290 data-nosnippet>290</a> <span class="number">40 </span>=&gt; PropertyType::WildcardSubscriptionAvailable,
<a href=#291 id=291 data-nosnippet>291</a> <span class="number">41 </span>=&gt; PropertyType::SubscriptionIdentifierAvailable,
<a href=#292 id=292 data-nosnippet>292</a> <span class="number">42 </span>=&gt; PropertyType::SharedSubscriptionAvailable,
<a href=#293 id=293 data-nosnippet>293</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(num)),
<a href=#294 id=294 data-nosnippet>294</a> };
<a href=#295 id=295 data-nosnippet>295</a>
<a href=#296 id=296 data-nosnippet>296</a> <span class="prelude-val">Ok</span>(property)
<a href=#297 id=297 data-nosnippet>297</a>}
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a><span class="doccomment">/// Checks if the stream has enough bytes to frame a packet and returns fixed header
<a href=#300 id=300 data-nosnippet>300</a>/// only if a packet can be framed with existing bytes in the `stream`.
<a href=#301 id=301 data-nosnippet>301</a>/// The passed stream doesn't modify parent stream's cursor. If this function
<a href=#302 id=302 data-nosnippet>302</a>/// returned an error, next `check` on the same parent stream is forced start
<a href=#303 id=303 data-nosnippet>303</a>/// with cursor at 0 again (Iter is owned. Only Iter's cursor is changed internally)
<a href=#304 id=304 data-nosnippet>304</a></span><span class="kw">pub fn </span>check(stream: Iter&lt;u8&gt;, max_packet_size: <span class="prelude-ty">Option</span>&lt;usize&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;FixedHeader, Error&gt; {
<a href=#305 id=305 data-nosnippet>305</a> <span class="comment">// Create fixed header if there are enough bytes in the stream
<a href=#306 id=306 data-nosnippet>306</a> // to frame full packet
<a href=#307 id=307 data-nosnippet>307</a> </span><span class="kw">let </span>stream_len = stream.len();
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream)<span class="question-mark">?</span>;
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a> <span class="comment">// Don't let rogue connections attack with huge payloads.
<a href=#311 id=311 data-nosnippet>311</a> // Disconnect them before reading all that data
<a href=#312 id=312 data-nosnippet>312</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(max_size) = max_packet_size {
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">if </span>fixed_header.remaining_len &gt; max_size {
<a href=#314 id=314 data-nosnippet>314</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PayloadSizeLimitExceeded {
<a href=#315 id=315 data-nosnippet>315</a> pkt_size: fixed_header.remaining_len,
<a href=#316 id=316 data-nosnippet>316</a> max: max_size,
<a href=#317 id=317 data-nosnippet>317</a> });
<a href=#318 id=318 data-nosnippet>318</a> }
<a href=#319 id=319 data-nosnippet>319</a> }
<a href=#320 id=320 data-nosnippet>320</a>
<a href=#321 id=321 data-nosnippet>321</a> <span class="comment">// If the current call fails due to insufficient bytes in the stream,
<a href=#322 id=322 data-nosnippet>322</a> // after calculating remaining length, we extend the stream
<a href=#323 id=323 data-nosnippet>323</a> </span><span class="kw">let </span>frame_length = fixed_header.frame_length();
<a href=#324 id=324 data-nosnippet>324</a> <span class="kw">if </span>stream_len &lt; frame_length {
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InsufficientBytes(frame_length - stream_len));
<a href=#326 id=326 data-nosnippet>326</a> }
<a href=#327 id=327 data-nosnippet>327</a>
<a href=#328 id=328 data-nosnippet>328</a> <span class="prelude-val">Ok</span>(fixed_header)
<a href=#329 id=329 data-nosnippet>329</a>}
<a href=#330 id=330 data-nosnippet>330</a>
<a href=#331 id=331 data-nosnippet>331</a><span class="doccomment">/// Parses fixed header
<a href=#332 id=332 data-nosnippet>332</a></span><span class="kw">fn </span>parse_fixed_header(<span class="kw-2">mut </span>stream: Iter&lt;u8&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;FixedHeader, Error&gt; {
<a href=#333 id=333 data-nosnippet>333</a> <span class="comment">// At least 2 bytes are necessary to frame a packet
<a href=#334 id=334 data-nosnippet>334</a> </span><span class="kw">let </span>stream_len = stream.len();
<a href=#335 id=335 data-nosnippet>335</a> <span class="kw">if </span>stream_len &lt; <span class="number">2 </span>{
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InsufficientBytes(<span class="number">2 </span>- stream_len));
<a href=#337 id=337 data-nosnippet>337</a> }
<a href=#338 id=338 data-nosnippet>338</a>
<a href=#339 id=339 data-nosnippet>339</a> <span class="kw">let </span>byte1 = stream.next().unwrap();
<a href=#340 id=340 data-nosnippet>340</a> <span class="kw">let </span>(len_len, len) = length(stream)<span class="question-mark">?</span>;
<a href=#341 id=341 data-nosnippet>341</a>
<a href=#342 id=342 data-nosnippet>342</a> <span class="prelude-val">Ok</span>(FixedHeader::new(<span class="kw-2">*</span>byte1, len_len, len))
<a href=#343 id=343 data-nosnippet>343</a>}
<a href=#344 id=344 data-nosnippet>344</a>
<a href=#345 id=345 data-nosnippet>345</a><span class="doccomment">/// Parses variable byte integer in the stream and returns the length
<a href=#346 id=346 data-nosnippet>346</a>/// and number of bytes that make it. Used for remaining length calculation
<a href=#347 id=347 data-nosnippet>347</a>/// as well as for calculating property lengths
<a href=#348 id=348 data-nosnippet>348</a></span><span class="kw">fn </span>length(stream: Iter&lt;u8&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(usize, usize), Error&gt; {
<a href=#349 id=349 data-nosnippet>349</a> <span class="kw">let </span><span class="kw-2">mut </span>len: usize = <span class="number">0</span>;
<a href=#350 id=350 data-nosnippet>350</a> <span class="kw">let </span><span class="kw-2">mut </span>len_len = <span class="number">0</span>;
<a href=#351 id=351 data-nosnippet>351</a> <span class="kw">let </span><span class="kw-2">mut </span>done = <span class="bool-val">false</span>;
<a href=#352 id=352 data-nosnippet>352</a> <span class="kw">let </span><span class="kw-2">mut </span>shift = <span class="number">0</span>;
<a href=#353 id=353 data-nosnippet>353</a>
<a href=#354 id=354 data-nosnippet>354</a> <span class="comment">// Use continuation bit at position 7 to continue reading next
<a href=#355 id=355 data-nosnippet>355</a> // byte to frame 'length'.
<a href=#356 id=356 data-nosnippet>356</a> // Stream 0b1xxx_xxxx 0b1yyy_yyyy 0b1zzz_zzzz 0b0www_wwww will
<a href=#357 id=357 data-nosnippet>357</a> // be framed as number 0bwww_wwww_zzz_zzzz_yyy_yyyy_xxx_xxxx
<a href=#358 id=358 data-nosnippet>358</a> </span><span class="kw">for </span>byte <span class="kw">in </span>stream {
<a href=#359 id=359 data-nosnippet>359</a> len_len += <span class="number">1</span>;
<a href=#360 id=360 data-nosnippet>360</a> <span class="kw">let </span>byte = <span class="kw-2">*</span>byte <span class="kw">as </span>usize;
<a href=#361 id=361 data-nosnippet>361</a> len += (byte &amp; <span class="number">0x7F</span>) &lt;&lt; shift;
<a href=#362 id=362 data-nosnippet>362</a>
<a href=#363 id=363 data-nosnippet>363</a> <span class="comment">// stop when continue bit is 0
<a href=#364 id=364 data-nosnippet>364</a> </span>done = (byte &amp; <span class="number">0x80</span>) == <span class="number">0</span>;
<a href=#365 id=365 data-nosnippet>365</a> <span class="kw">if </span>done {
<a href=#366 id=366 data-nosnippet>366</a> <span class="kw">break</span>;
<a href=#367 id=367 data-nosnippet>367</a> }
<a href=#368 id=368 data-nosnippet>368</a>
<a href=#369 id=369 data-nosnippet>369</a> shift += <span class="number">7</span>;
<a href=#370 id=370 data-nosnippet>370</a>
<a href=#371 id=371 data-nosnippet>371</a> <span class="comment">// Only a max of 4 bytes allowed for remaining length
<a href=#372 id=372 data-nosnippet>372</a> // more than 4 shifts (0, 7, 14, 21) implies bad length
<a href=#373 id=373 data-nosnippet>373</a> </span><span class="kw">if </span>shift &gt; <span class="number">21 </span>{
<a href=#374 id=374 data-nosnippet>374</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedRemainingLength);
<a href=#375 id=375 data-nosnippet>375</a> }
<a href=#376 id=376 data-nosnippet>376</a> }
<a href=#377 id=377 data-nosnippet>377</a>
<a href=#378 id=378 data-nosnippet>378</a> <span class="comment">// Not enough bytes to frame remaining length. wait for
<a href=#379 id=379 data-nosnippet>379</a> // one more byte
<a href=#380 id=380 data-nosnippet>380</a> </span><span class="kw">if </span>!done {
<a href=#381 id=381 data-nosnippet>381</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InsufficientBytes(<span class="number">1</span>));
<a href=#382 id=382 data-nosnippet>382</a> }
<a href=#383 id=383 data-nosnippet>383</a>
<a href=#384 id=384 data-nosnippet>384</a> <span class="prelude-val">Ok</span>((len_len, len))
<a href=#385 id=385 data-nosnippet>385</a>}
<a href=#386 id=386 data-nosnippet>386</a>
<a href=#387 id=387 data-nosnippet>387</a><span class="doccomment">/// Reads a series of bytes with a length from a byte stream
<a href=#388 id=388 data-nosnippet>388</a></span><span class="kw">fn </span>read_mqtt_bytes(stream: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;Bytes, Error&gt; {
<a href=#389 id=389 data-nosnippet>389</a> <span class="kw">let </span>len = read_u16(stream)<span class="question-mark">? </span><span class="kw">as </span>usize;
<a href=#390 id=390 data-nosnippet>390</a>
<a href=#391 id=391 data-nosnippet>391</a> <span class="comment">// Prevent attacks with wrong remaining length. This method is used in
<a href=#392 id=392 data-nosnippet>392</a> // `packet.assembly()` with (enough) bytes to frame packet. Ensures that
<a href=#393 id=393 data-nosnippet>393</a> // reading variable len string or bytes doesn't cross promised boundary
<a href=#394 id=394 data-nosnippet>394</a> // with `read_fixed_header()`
<a href=#395 id=395 data-nosnippet>395</a> </span><span class="kw">if </span>len &gt; stream.len() {
<a href=#396 id=396 data-nosnippet>396</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::BoundaryCrossed(len));
<a href=#397 id=397 data-nosnippet>397</a> }
<a href=#398 id=398 data-nosnippet>398</a>
<a href=#399 id=399 data-nosnippet>399</a> <span class="prelude-val">Ok</span>(stream.split_to(len))
<a href=#400 id=400 data-nosnippet>400</a>}
<a href=#401 id=401 data-nosnippet>401</a>
<a href=#402 id=402 data-nosnippet>402</a><span class="doccomment">/// Reads a string from bytes stream
<a href=#403 id=403 data-nosnippet>403</a></span><span class="kw">fn </span>read_mqtt_string(stream: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;String, Error&gt; {
<a href=#404 id=404 data-nosnippet>404</a> <span class="kw">let </span>s = read_mqtt_bytes(stream)<span class="question-mark">?</span>;
<a href=#405 id=405 data-nosnippet>405</a> <span class="kw">match </span>String::from_utf8(s.to_vec()) {
<a href=#406 id=406 data-nosnippet>406</a> <span class="prelude-val">Ok</span>(v) =&gt; <span class="prelude-val">Ok</span>(v),
<a href=#407 id=407 data-nosnippet>407</a> <span class="prelude-val">Err</span>(_e) =&gt; <span class="prelude-val">Err</span>(Error::TopicNotUtf8),
<a href=#408 id=408 data-nosnippet>408</a> }
<a href=#409 id=409 data-nosnippet>409</a>}
<a href=#410 id=410 data-nosnippet>410</a>
<a href=#411 id=411 data-nosnippet>411</a><span class="doccomment">/// Serializes bytes to stream (including length)
<a href=#412 id=412 data-nosnippet>412</a></span><span class="kw">fn </span>write_mqtt_bytes(stream: <span class="kw-2">&amp;mut </span>BytesMut, bytes: <span class="kw-2">&amp;</span>[u8]) {
<a href=#413 id=413 data-nosnippet>413</a> stream.put_u16(bytes.len() <span class="kw">as </span>u16);
<a href=#414 id=414 data-nosnippet>414</a> stream.extend_from_slice(bytes);
<a href=#415 id=415 data-nosnippet>415</a>}
<a href=#416 id=416 data-nosnippet>416</a>
<a href=#417 id=417 data-nosnippet>417</a><span class="doccomment">/// Serializes a string to stream
<a href=#418 id=418 data-nosnippet>418</a></span><span class="kw">fn </span>write_mqtt_string(stream: <span class="kw-2">&amp;mut </span>BytesMut, string: <span class="kw-2">&amp;</span>str) {
<a href=#419 id=419 data-nosnippet>419</a> write_mqtt_bytes(stream, string.as_bytes());
<a href=#420 id=420 data-nosnippet>420</a>}
<a href=#421 id=421 data-nosnippet>421</a>
<a href=#422 id=422 data-nosnippet>422</a><span class="doccomment">/// Writes remaining length to stream and returns number of bytes for remaining length
<a href=#423 id=423 data-nosnippet>423</a></span><span class="kw">fn </span>write_remaining_length(stream: <span class="kw-2">&amp;mut </span>BytesMut, len: usize) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#424 id=424 data-nosnippet>424</a> <span class="kw">if </span>len &gt; <span class="number">268_435_455 </span>{
<a href=#425 id=425 data-nosnippet>425</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PayloadTooLong);
<a href=#426 id=426 data-nosnippet>426</a> }
<a href=#427 id=427 data-nosnippet>427</a>
<a href=#428 id=428 data-nosnippet>428</a> <span class="kw">let </span><span class="kw-2">mut </span>done = <span class="bool-val">false</span>;
<a href=#429 id=429 data-nosnippet>429</a> <span class="kw">let </span><span class="kw-2">mut </span>x = len;
<a href=#430 id=430 data-nosnippet>430</a> <span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0</span>;
<a href=#431 id=431 data-nosnippet>431</a>
<a href=#432 id=432 data-nosnippet>432</a> <span class="kw">while </span>!done {
<a href=#433 id=433 data-nosnippet>433</a> <span class="kw">let </span><span class="kw-2">mut </span>byte = (x % <span class="number">128</span>) <span class="kw">as </span>u8;
<a href=#434 id=434 data-nosnippet>434</a> x /= <span class="number">128</span>;
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">if </span>x &gt; <span class="number">0 </span>{
<a href=#436 id=436 data-nosnippet>436</a> byte |= <span class="number">128</span>;
<a href=#437 id=437 data-nosnippet>437</a> }
<a href=#438 id=438 data-nosnippet>438</a>
<a href=#439 id=439 data-nosnippet>439</a> stream.put_u8(byte);
<a href=#440 id=440 data-nosnippet>440</a> count += <span class="number">1</span>;
<a href=#441 id=441 data-nosnippet>441</a> done = x == <span class="number">0</span>;
<a href=#442 id=442 data-nosnippet>442</a> }
<a href=#443 id=443 data-nosnippet>443</a>
<a href=#444 id=444 data-nosnippet>444</a> <span class="prelude-val">Ok</span>(count)
<a href=#445 id=445 data-nosnippet>445</a>}
<a href=#446 id=446 data-nosnippet>446</a>
<a href=#447 id=447 data-nosnippet>447</a><span class="doccomment">/// Return number of remaining length bytes required for encoding length
<a href=#448 id=448 data-nosnippet>448</a></span><span class="kw">fn </span>len_len(len: usize) -&gt; usize {
<a href=#449 id=449 data-nosnippet>449</a> <span class="kw">if </span>len &gt;= <span class="number">2_097_152 </span>{
<a href=#450 id=450 data-nosnippet>450</a> <span class="number">4
<a href=#451 id=451 data-nosnippet>451</a> </span>} <span class="kw">else if </span>len &gt;= <span class="number">16_384 </span>{
<a href=#452 id=452 data-nosnippet>452</a> <span class="number">3
<a href=#453 id=453 data-nosnippet>453</a> </span>} <span class="kw">else if </span>len &gt;= <span class="number">128 </span>{
<a href=#454 id=454 data-nosnippet>454</a> <span class="number">2
<a href=#455 id=455 data-nosnippet>455</a> </span>} <span class="kw">else </span>{
<a href=#456 id=456 data-nosnippet>456</a> <span class="number">1
<a href=#457 id=457 data-nosnippet>457</a> </span>}
<a href=#458 id=458 data-nosnippet>458</a>}
<a href=#459 id=459 data-nosnippet>459</a>
<a href=#460 id=460 data-nosnippet>460</a><span class="doccomment">/// After collecting enough bytes to frame a packet (packet's frame())
<a href=#461 id=461 data-nosnippet>461</a>/// , It's possible that content itself in the stream is wrong. Like expected
<a href=#462 id=462 data-nosnippet>462</a>/// packet id or qos not being present. In cases where `read_mqtt_string` or
<a href=#463 id=463 data-nosnippet>463</a>/// `read_mqtt_bytes` exhausted remaining length but packet framing expects to
<a href=#464 id=464 data-nosnippet>464</a>/// parse qos next, these pre checks will prevent `bytes` crashes
<a href=#465 id=465 data-nosnippet>465</a></span><span class="kw">fn </span>read_u16(stream: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;u16, Error&gt; {
<a href=#466 id=466 data-nosnippet>466</a> <span class="kw">if </span>stream.len() &lt; <span class="number">2 </span>{
<a href=#467 id=467 data-nosnippet>467</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#468 id=468 data-nosnippet>468</a> }
<a href=#469 id=469 data-nosnippet>469</a>
<a href=#470 id=470 data-nosnippet>470</a> <span class="prelude-val">Ok</span>(stream.get_u16())
<a href=#471 id=471 data-nosnippet>471</a>}
<a href=#472 id=472 data-nosnippet>472</a>
<a href=#473 id=473 data-nosnippet>473</a><span class="kw">fn </span>read_u8(stream: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;u8, Error&gt; {
<a href=#474 id=474 data-nosnippet>474</a> <span class="kw">if </span>stream.is_empty() {
<a href=#475 id=475 data-nosnippet>475</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#476 id=476 data-nosnippet>476</a> }
<a href=#477 id=477 data-nosnippet>477</a>
<a href=#478 id=478 data-nosnippet>478</a> <span class="prelude-val">Ok</span>(stream.get_u8())
<a href=#479 id=479 data-nosnippet>479</a>}
<a href=#480 id=480 data-nosnippet>480</a>
<a href=#481 id=481 data-nosnippet>481</a><span class="kw">fn </span>read_u32(stream: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;u32, Error&gt; {
<a href=#482 id=482 data-nosnippet>482</a> <span class="kw">if </span>stream.len() &lt; <span class="number">4 </span>{
<a href=#483 id=483 data-nosnippet>483</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#484 id=484 data-nosnippet>484</a> }
<a href=#485 id=485 data-nosnippet>485</a>
<a href=#486 id=486 data-nosnippet>486</a> <span class="prelude-val">Ok</span>(stream.get_u32())
<a href=#487 id=487 data-nosnippet>487</a>}
<a href=#488 id=488 data-nosnippet>488</a>
<a href=#489 id=489 data-nosnippet>489</a><span class="kw">mod </span>test {
<a href=#490 id=490 data-nosnippet>490</a> <span class="comment">// These are used in tests by packets
<a href=#491 id=491 data-nosnippet>491</a> </span><span class="attr">#[allow(dead_code)]
<a href=#492 id=492 data-nosnippet>492</a> </span><span class="kw">pub const </span>USER_PROP_KEY: <span class="kw-2">&amp;</span>str = <span class="string">"property"</span>;
<a href=#493 id=493 data-nosnippet>493</a> <span class="attr">#[allow(dead_code)]
<a href=#494 id=494 data-nosnippet>494</a> </span><span class="kw">pub const </span>USER_PROP_VAL: <span class="kw-2">&amp;</span>str = <span class="string">"a value thats really long............................................................................................................"</span>;
<a href=#495 id=495 data-nosnippet>495</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,22 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/ping.rs`."><title>ping.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>ping.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{BufMut, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">pub struct </span>PingReq;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">impl </span>PingReq {
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub fn </span>write(payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#9 id=9 data-nosnippet>9</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xC0</span>, <span class="number">0x00</span>]);
<a href=#10 id=10 data-nosnippet>10</a> <span class="prelude-val">Ok</span>(<span class="number">2</span>)
<a href=#11 id=11 data-nosnippet>11</a> }
<a href=#12 id=12 data-nosnippet>12</a>}
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub struct </span>PingResp;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">impl </span>PingResp {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">pub fn </span>write(payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#19 id=19 data-nosnippet>19</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xD0</span>, <span class="number">0x00</span>]);
<a href=#20 id=20 data-nosnippet>20</a> <span class="prelude-val">Ok</span>(<span class="number">2</span>)
<a href=#21 id=21 data-nosnippet>21</a> }
<a href=#22 id=22 data-nosnippet>22</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,259 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/puback.rs`."><title>puback.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>puback.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Return code in puback
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub enum </span>PubAckReason {
<a href=#7 id=7 data-nosnippet>7</a> Success,
<a href=#8 id=8 data-nosnippet>8</a> NoMatchingSubscribers,
<a href=#9 id=9 data-nosnippet>9</a> UnspecifiedError,
<a href=#10 id=10 data-nosnippet>10</a> ImplementationSpecificError,
<a href=#11 id=11 data-nosnippet>11</a> NotAuthorized,
<a href=#12 id=12 data-nosnippet>12</a> TopicNameInvalid,
<a href=#13 id=13 data-nosnippet>13</a> PacketIdentifierInUse,
<a href=#14 id=14 data-nosnippet>14</a> QuotaExceeded,
<a href=#15 id=15 data-nosnippet>15</a> PayloadFormatInvalid,
<a href=#16 id=16 data-nosnippet>16</a>}
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="doccomment">/// Acknowledgement to QoS1 publish
<a href=#19 id=19 data-nosnippet>19</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub struct </span>PubAck {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub </span>pkid: u16,
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">pub </span>reason: PubAckReason,
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;PubAckProperties&gt;,
<a href=#24 id=24 data-nosnippet>24</a>}
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">impl </span>PubAck {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">pub fn </span>new(pkid: u16, properties: <span class="prelude-ty">Option</span>&lt;PubAckProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#28 id=28 data-nosnippet>28</a> <span class="self">Self </span>{
<a href=#29 id=29 data-nosnippet>29</a> pkid,
<a href=#30 id=30 data-nosnippet>30</a> reason: PubAckReason::Success,
<a href=#31 id=31 data-nosnippet>31</a> properties,
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">if </span><span class="self">self</span>.reason == PubAckReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">return </span><span class="number">4</span>;
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#43 id=43 data-nosnippet>43</a> }
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="number">1</span>; <span class="comment">// pkid + reason
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> // If there are no properties, sending reason code is optional
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubAckReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">return </span><span class="number">2</span>;
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">let </span>properties_len = p.len();
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#56 id=56 data-nosnippet>56</a> len += properties_len_len + properties_len;
<a href=#57 id=57 data-nosnippet>57</a> } <span class="kw">else </span>{
<a href=#58 id=58 data-nosnippet>58</a> <span class="comment">// just 1 byte representing 0 len properties
<a href=#59 id=59 data-nosnippet>59</a> </span>len += <span class="number">1</span>;
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> len
<a href=#63 id=63 data-nosnippet>63</a> }
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;PubAck, Error&gt; {
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#67 id=67 data-nosnippet>67</a> bytes.advance(variable_header_index);
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a> <span class="comment">// No reason code or properties if remaining length == 2
<a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubAck {
<a href=#73 id=73 data-nosnippet>73</a> pkid,
<a href=#74 id=74 data-nosnippet>74</a> reason: PubAckReason::Success,
<a href=#75 id=75 data-nosnippet>75</a> properties: <span class="prelude-val">None</span>,
<a href=#76 id=76 data-nosnippet>76</a> });
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="comment">// No properties len or properties if remaining len &gt; 2 but &lt; 4
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">let </span>ack_reason = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubAck {
<a href=#83 id=83 data-nosnippet>83</a> pkid,
<a href=#84 id=84 data-nosnippet>84</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#85 id=85 data-nosnippet>85</a> properties: <span class="prelude-val">None</span>,
<a href=#86 id=86 data-nosnippet>86</a> });
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>properties = PubAckProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">let </span>puback = PubAck {
<a href=#91 id=91 data-nosnippet>91</a> pkid,
<a href=#92 id=92 data-nosnippet>92</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#93 id=93 data-nosnippet>93</a> properties,
<a href=#94 id=94 data-nosnippet>94</a> };
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> <span class="prelude-val">Ok</span>(puback)
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#101 id=101 data-nosnippet>101</a> buffer.put_u8(<span class="number">0x40</span>);
<a href=#102 id=102 data-nosnippet>102</a>
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#104 id=104 data-nosnippet>104</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="comment">// Reason code is optional with success if there are no properties
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubAckReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#108 id=108 data-nosnippet>108</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">4</span>);
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> buffer.put_u8(code(<span class="self">self</span>.reason));
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#113 id=113 data-nosnippet>113</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#114 id=114 data-nosnippet>114</a> } <span class="kw">else </span>{
<a href=#115 id=115 data-nosnippet>115</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a>}
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#123 id=123 data-nosnippet>123</a></span><span class="kw">pub struct </span>PubAckProperties {
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#126 id=126 data-nosnippet>126</a>}
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a><span class="kw">impl </span>PubAckProperties {
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#133 id=133 data-nosnippet>133</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#137 id=137 data-nosnippet>137</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a>
<a href=#140 id=140 data-nosnippet>140</a> len
<a href=#141 id=141 data-nosnippet>141</a> }
<a href=#142 id=142 data-nosnippet>142</a>
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;PubAckProperties&gt;, Error&gt; {
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#148 id=148 data-nosnippet>148</a> bytes.advance(properties_len_len);
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#151 id=151 data-nosnippet>151</a> }
<a href=#152 id=152 data-nosnippet>152</a>
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#154 id=154 data-nosnippet>154</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#155 id=155 data-nosnippet>155</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#157 id=157 data-nosnippet>157</a> cursor += <span class="number">1</span>;
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#160 id=160 data-nosnippet>160</a> PropertyType::ReasonString =&gt; {
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#162 id=162 data-nosnippet>162</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#163 id=163 data-nosnippet>163</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a> PropertyType::UserProperty =&gt; {
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#168 id=168 data-nosnippet>168</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#169 id=169 data-nosnippet>169</a> user_properties.push((key, value));
<a href=#170 id=170 data-nosnippet>170</a> }
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#172 id=172 data-nosnippet>172</a> }
<a href=#173 id=173 data-nosnippet>173</a> }
<a href=#174 id=174 data-nosnippet>174</a>
<a href=#175 id=175 data-nosnippet>175</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(PubAckProperties {
<a href=#176 id=176 data-nosnippet>176</a> reason_string,
<a href=#177 id=177 data-nosnippet>177</a> user_properties,
<a href=#178 id=178 data-nosnippet>178</a> }))
<a href=#179 id=179 data-nosnippet>179</a> }
<a href=#180 id=180 data-nosnippet>180</a>
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#183 id=183 data-nosnippet>183</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#186 id=186 data-nosnippet>186</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#187 id=187 data-nosnippet>187</a> write_mqtt_string(buffer, reason);
<a href=#188 id=188 data-nosnippet>188</a> }
<a href=#189 id=189 data-nosnippet>189</a>
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#191 id=191 data-nosnippet>191</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#192 id=192 data-nosnippet>192</a> write_mqtt_string(buffer, key);
<a href=#193 id=193 data-nosnippet>193</a> write_mqtt_string(buffer, value);
<a href=#194 id=194 data-nosnippet>194</a> }
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a> <span class="prelude-val">Ok</span>(())
<a href=#197 id=197 data-nosnippet>197</a> }
<a href=#198 id=198 data-nosnippet>198</a>}
<a href=#199 id=199 data-nosnippet>199</a>
<a href=#200 id=200 data-nosnippet>200</a><span class="doccomment">/// Connection return code type
<a href=#201 id=201 data-nosnippet>201</a></span><span class="kw">fn </span>reason(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;PubAckReason, Error&gt; {
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#203 id=203 data-nosnippet>203</a> <span class="number">0 </span>=&gt; PubAckReason::Success,
<a href=#204 id=204 data-nosnippet>204</a> <span class="number">16 </span>=&gt; PubAckReason::NoMatchingSubscribers,
<a href=#205 id=205 data-nosnippet>205</a> <span class="number">128 </span>=&gt; PubAckReason::UnspecifiedError,
<a href=#206 id=206 data-nosnippet>206</a> <span class="number">131 </span>=&gt; PubAckReason::ImplementationSpecificError,
<a href=#207 id=207 data-nosnippet>207</a> <span class="number">135 </span>=&gt; PubAckReason::NotAuthorized,
<a href=#208 id=208 data-nosnippet>208</a> <span class="number">144 </span>=&gt; PubAckReason::TopicNameInvalid,
<a href=#209 id=209 data-nosnippet>209</a> <span class="number">145 </span>=&gt; PubAckReason::PacketIdentifierInUse,
<a href=#210 id=210 data-nosnippet>210</a> <span class="number">151 </span>=&gt; PubAckReason::QuotaExceeded,
<a href=#211 id=211 data-nosnippet>211</a> <span class="number">153 </span>=&gt; PubAckReason::PayloadFormatInvalid,
<a href=#212 id=212 data-nosnippet>212</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<a href=#213 id=213 data-nosnippet>213</a> };
<a href=#214 id=214 data-nosnippet>214</a>
<a href=#215 id=215 data-nosnippet>215</a> <span class="prelude-val">Ok</span>(code)
<a href=#216 id=216 data-nosnippet>216</a>}
<a href=#217 id=217 data-nosnippet>217</a>
<a href=#218 id=218 data-nosnippet>218</a><span class="comment">// TODO: Is typecasting significantly faster than functions?
<a href=#219 id=219 data-nosnippet>219</a></span><span class="kw">fn </span>code(reason: PubAckReason) -&gt; u8 {
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">match </span>reason {
<a href=#221 id=221 data-nosnippet>221</a> PubAckReason::Success =&gt; <span class="number">0</span>,
<a href=#222 id=222 data-nosnippet>222</a> PubAckReason::NoMatchingSubscribers =&gt; <span class="number">16</span>,
<a href=#223 id=223 data-nosnippet>223</a> PubAckReason::UnspecifiedError =&gt; <span class="number">128</span>,
<a href=#224 id=224 data-nosnippet>224</a> PubAckReason::ImplementationSpecificError =&gt; <span class="number">131</span>,
<a href=#225 id=225 data-nosnippet>225</a> PubAckReason::NotAuthorized =&gt; <span class="number">135</span>,
<a href=#226 id=226 data-nosnippet>226</a> PubAckReason::TopicNameInvalid =&gt; <span class="number">144</span>,
<a href=#227 id=227 data-nosnippet>227</a> PubAckReason::PacketIdentifierInUse =&gt; <span class="number">145</span>,
<a href=#228 id=228 data-nosnippet>228</a> PubAckReason::QuotaExceeded =&gt; <span class="number">151</span>,
<a href=#229 id=229 data-nosnippet>229</a> PubAckReason::PayloadFormatInvalid =&gt; <span class="number">153</span>,
<a href=#230 id=230 data-nosnippet>230</a> }
<a href=#231 id=231 data-nosnippet>231</a>}
<a href=#232 id=232 data-nosnippet>232</a>
<a href=#233 id=233 data-nosnippet>233</a><span class="attr">#[cfg(test)]
<a href=#234 id=234 data-nosnippet>234</a></span><span class="kw">mod </span>test {
<a href=#235 id=235 data-nosnippet>235</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#236 id=236 data-nosnippet>236</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#239 id=239 data-nosnippet>239</a>
<a href=#240 id=240 data-nosnippet>240</a> <span class="attr">#[test]
<a href=#241 id=241 data-nosnippet>241</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#242 id=242 data-nosnippet>242</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#243 id=243 data-nosnippet>243</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#244 id=244 data-nosnippet>244</a> // remaining_length field in the packet be 2 bytes long.
<a href=#245 id=245 data-nosnippet>245</a> </span><span class="kw">let </span>puback_props = PubAckProperties {
<a href=#246 id=246 data-nosnippet>246</a> reason_string: <span class="prelude-val">None</span>,
<a href=#247 id=247 data-nosnippet>247</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#248 id=248 data-nosnippet>248</a> };
<a href=#249 id=249 data-nosnippet>249</a>
<a href=#250 id=250 data-nosnippet>250</a> <span class="kw">let </span>puback_pkt = PubAck::new(<span class="number">1</span>, <span class="prelude-val">Some</span>(puback_props));
<a href=#251 id=251 data-nosnippet>251</a>
<a href=#252 id=252 data-nosnippet>252</a> <span class="kw">let </span>size_from_size = puback_pkt.size();
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">let </span>size_from_write = puback_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#254 id=254 data-nosnippet>254</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#255 id=255 data-nosnippet>255</a>
<a href=#256 id=256 data-nosnippet>256</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#257 id=257 data-nosnippet>257</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#258 id=258 data-nosnippet>258</a> }
<a href=#259 id=259 data-nosnippet>259</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,237 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/pubcomp.rs`."><title>pubcomp.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>pubcomp.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Return code in PubComp
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a>#[repr(u8)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub enum </span>PubCompReason {
<a href=#8 id=8 data-nosnippet>8</a> Success,
<a href=#9 id=9 data-nosnippet>9</a> PacketIdentifierNotFound,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="doccomment">/// QoS2 Assured publish complete, in response to PUBREL packet
<a href=#13 id=13 data-nosnippet>13</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#14 id=14 data-nosnippet>14</a></span><span class="kw">pub struct </span>PubComp {
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub </span>pkid: u16,
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">pub </span>reason: PubCompReason,
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;PubCompProperties&gt;,
<a href=#18 id=18 data-nosnippet>18</a>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">impl </span>PubComp {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub fn </span>new(pkid: u16, properties: <span class="prelude-ty">Option</span>&lt;PubCompProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#22 id=22 data-nosnippet>22</a> <span class="self">Self </span>{
<a href=#23 id=23 data-nosnippet>23</a> pkid,
<a href=#24 id=24 data-nosnippet>24</a> reason: PubCompReason::Success,
<a href=#25 id=25 data-nosnippet>25</a> properties,
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">if </span><span class="self">self</span>.reason == PubCompReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">return </span><span class="number">4</span>;
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="number">1</span>; <span class="comment">// pkid + reason
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
<a href=#43 id=43 data-nosnippet>43</a> // and there are no Properties. In this case the PUBCOMP has a Remaining Length of 2.
<a href=#44 id=44 data-nosnippet>44</a> // &lt;https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154&gt;
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubCompReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">return </span><span class="number">2</span>;
<a href=#47 id=47 data-nosnippet>47</a> }
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>properties_len = p.len();
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#52 id=52 data-nosnippet>52</a> len += properties_len_len + properties_len;
<a href=#53 id=53 data-nosnippet>53</a> } <span class="kw">else </span>{
<a href=#54 id=54 data-nosnippet>54</a> len += <span class="number">1</span>;
<a href=#55 id=55 data-nosnippet>55</a> }
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a> len
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a>
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;PubComp, Error&gt; {
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#62 id=62 data-nosnippet>62</a> bytes.advance(variable_header_index);
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubComp {
<a href=#67 id=67 data-nosnippet>67</a> pkid,
<a href=#68 id=68 data-nosnippet>68</a> reason: PubCompReason::Success,
<a href=#69 id=69 data-nosnippet>69</a> properties: <span class="prelude-val">None</span>,
<a href=#70 id=70 data-nosnippet>70</a> });
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>ack_reason = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubComp {
<a href=#76 id=76 data-nosnippet>76</a> pkid,
<a href=#77 id=77 data-nosnippet>77</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#78 id=78 data-nosnippet>78</a> properties: <span class="prelude-val">None</span>,
<a href=#79 id=79 data-nosnippet>79</a> });
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>properties = PubCompProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>puback = PubComp {
<a href=#84 id=84 data-nosnippet>84</a> pkid,
<a href=#85 id=85 data-nosnippet>85</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#86 id=86 data-nosnippet>86</a> properties,
<a href=#87 id=87 data-nosnippet>87</a> };
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="prelude-val">Ok</span>(puback)
<a href=#90 id=90 data-nosnippet>90</a> }
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#94 id=94 data-nosnippet>94</a> buffer.put_u8(<span class="number">0x70</span>);
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#96 id=96 data-nosnippet>96</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a> <span class="comment">// If there are no properties during success, sending reason code is optional
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubCompReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">4</span>);
<a href=#101 id=101 data-nosnippet>101</a> }
<a href=#102 id=102 data-nosnippet>102</a>
<a href=#103 id=103 data-nosnippet>103</a> buffer.put_u8(code(<span class="self">self</span>.reason));
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#106 id=106 data-nosnippet>106</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#107 id=107 data-nosnippet>107</a> } <span class="kw">else </span>{
<a href=#108 id=108 data-nosnippet>108</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#112 id=112 data-nosnippet>112</a> }
<a href=#113 id=113 data-nosnippet>113</a>}
<a href=#114 id=114 data-nosnippet>114</a>
<a href=#115 id=115 data-nosnippet>115</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#116 id=116 data-nosnippet>116</a></span><span class="kw">pub struct </span>PubCompProperties {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#119 id=119 data-nosnippet>119</a>}
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a><span class="kw">impl </span>PubCompProperties {
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#126 id=126 data-nosnippet>126</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#130 id=130 data-nosnippet>130</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#131 id=131 data-nosnippet>131</a> }
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> len
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;PubCompProperties&gt;, Error&gt; {
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#139 id=139 data-nosnippet>139</a>
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#141 id=141 data-nosnippet>141</a> bytes.advance(properties_len_len);
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#144 id=144 data-nosnippet>144</a> }
<a href=#145 id=145 data-nosnippet>145</a>
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#147 id=147 data-nosnippet>147</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#150 id=150 data-nosnippet>150</a> cursor += <span class="number">1</span>;
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#153 id=153 data-nosnippet>153</a> PropertyType::ReasonString =&gt; {
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#155 id=155 data-nosnippet>155</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#156 id=156 data-nosnippet>156</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a> PropertyType::UserProperty =&gt; {
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#161 id=161 data-nosnippet>161</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#162 id=162 data-nosnippet>162</a> user_properties.push((key, value));
<a href=#163 id=163 data-nosnippet>163</a> }
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#165 id=165 data-nosnippet>165</a> }
<a href=#166 id=166 data-nosnippet>166</a> }
<a href=#167 id=167 data-nosnippet>167</a>
<a href=#168 id=168 data-nosnippet>168</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(PubCompProperties {
<a href=#169 id=169 data-nosnippet>169</a> reason_string,
<a href=#170 id=170 data-nosnippet>170</a> user_properties,
<a href=#171 id=171 data-nosnippet>171</a> }))
<a href=#172 id=172 data-nosnippet>172</a> }
<a href=#173 id=173 data-nosnippet>173</a>
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#176 id=176 data-nosnippet>176</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#179 id=179 data-nosnippet>179</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#180 id=180 data-nosnippet>180</a> write_mqtt_string(buffer, reason);
<a href=#181 id=181 data-nosnippet>181</a> }
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#184 id=184 data-nosnippet>184</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#185 id=185 data-nosnippet>185</a> write_mqtt_string(buffer, key);
<a href=#186 id=186 data-nosnippet>186</a> write_mqtt_string(buffer, value);
<a href=#187 id=187 data-nosnippet>187</a> }
<a href=#188 id=188 data-nosnippet>188</a>
<a href=#189 id=189 data-nosnippet>189</a> <span class="prelude-val">Ok</span>(())
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a>}
<a href=#192 id=192 data-nosnippet>192</a>
<a href=#193 id=193 data-nosnippet>193</a><span class="doccomment">/// Connection return code type
<a href=#194 id=194 data-nosnippet>194</a></span><span class="kw">fn </span>reason(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;PubCompReason, Error&gt; {
<a href=#195 id=195 data-nosnippet>195</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#196 id=196 data-nosnippet>196</a> <span class="number">0 </span>=&gt; PubCompReason::Success,
<a href=#197 id=197 data-nosnippet>197</a> <span class="number">146 </span>=&gt; PubCompReason::PacketIdentifierNotFound,
<a href=#198 id=198 data-nosnippet>198</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<a href=#199 id=199 data-nosnippet>199</a> };
<a href=#200 id=200 data-nosnippet>200</a>
<a href=#201 id=201 data-nosnippet>201</a> <span class="prelude-val">Ok</span>(code)
<a href=#202 id=202 data-nosnippet>202</a>}
<a href=#203 id=203 data-nosnippet>203</a>
<a href=#204 id=204 data-nosnippet>204</a><span class="kw">fn </span>code(reason: PubCompReason) -&gt; u8 {
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">match </span>reason {
<a href=#206 id=206 data-nosnippet>206</a> PubCompReason::Success =&gt; <span class="number">0</span>,
<a href=#207 id=207 data-nosnippet>207</a> PubCompReason::PacketIdentifierNotFound =&gt; <span class="number">146</span>,
<a href=#208 id=208 data-nosnippet>208</a> }
<a href=#209 id=209 data-nosnippet>209</a>}
<a href=#210 id=210 data-nosnippet>210</a>
<a href=#211 id=211 data-nosnippet>211</a><span class="attr">#[cfg(test)]
<a href=#212 id=212 data-nosnippet>212</a></span><span class="kw">mod </span>test {
<a href=#213 id=213 data-nosnippet>213</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#217 id=217 data-nosnippet>217</a>
<a href=#218 id=218 data-nosnippet>218</a> <span class="attr">#[test]
<a href=#219 id=219 data-nosnippet>219</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#221 id=221 data-nosnippet>221</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#222 id=222 data-nosnippet>222</a> // remaining_length field in the packet be 2 bytes long.
<a href=#223 id=223 data-nosnippet>223</a> </span><span class="kw">let </span>pubcomp_props = PubCompProperties {
<a href=#224 id=224 data-nosnippet>224</a> reason_string: <span class="prelude-val">None</span>,
<a href=#225 id=225 data-nosnippet>225</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#226 id=226 data-nosnippet>226</a> };
<a href=#227 id=227 data-nosnippet>227</a>
<a href=#228 id=228 data-nosnippet>228</a> <span class="kw">let </span>pubcomp_pkt = PubComp::new(<span class="number">1</span>, <span class="prelude-val">Some</span>(pubcomp_props));
<a href=#229 id=229 data-nosnippet>229</a>
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">let </span>size_from_size = pubcomp_pkt.size();
<a href=#231 id=231 data-nosnippet>231</a> <span class="kw">let </span>size_from_write = pubcomp_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#235 id=235 data-nosnippet>235</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#236 id=236 data-nosnippet>236</a> }
<a href=#237 id=237 data-nosnippet>237</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,340 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/publish.rs`."><title>publish.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>publish.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, Bytes};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Publish packet
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Default)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>Publish {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw">pub </span>dup: bool,
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>qos: QoS,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>retain: bool,
<a href=#10 id=10 data-nosnippet>10</a> <span class="kw">pub </span>topic: Bytes,
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub </span>pkid: u16,
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub </span>payload: Bytes,
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;PublishProperties&gt;,
<a href=#14 id=14 data-nosnippet>14</a>}
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">impl </span>Publish {
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">pub fn </span>new&lt;T: Into&lt;String&gt;, P: Into&lt;Bytes&gt;&gt;(
<a href=#18 id=18 data-nosnippet>18</a> topic: T,
<a href=#19 id=19 data-nosnippet>19</a> qos: QoS,
<a href=#20 id=20 data-nosnippet>20</a> payload: P,
<a href=#21 id=21 data-nosnippet>21</a> properties: <span class="prelude-ty">Option</span>&lt;PublishProperties&gt;,
<a href=#22 id=22 data-nosnippet>22</a> ) -&gt; <span class="self">Self </span>{
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>topic = Bytes::copy_from_slice(topic.into().as_bytes());
<a href=#24 id=24 data-nosnippet>24</a> <span class="self">Self </span>{
<a href=#25 id=25 data-nosnippet>25</a> qos,
<a href=#26 id=26 data-nosnippet>26</a> topic,
<a href=#27 id=27 data-nosnippet>27</a> payload: payload.into(),
<a href=#28 id=28 data-nosnippet>28</a> properties,
<a href=#29 id=29 data-nosnippet>29</a> ..Default::default()
<a href=#30 id=30 data-nosnippet>30</a> }
<a href=#31 id=31 data-nosnippet>31</a> }
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="self">self</span>.topic.len();
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if </span><span class="self">self</span>.qos != QoS::AtMostOnce &amp;&amp; <span class="self">self</span>.pkid != <span class="number">0 </span>{
<a href=#43 id=43 data-nosnippet>43</a> len += <span class="number">2</span>;
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>properties_len = p.len();
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#49 id=49 data-nosnippet>49</a> len += properties_len_len + properties_len;
<a href=#50 id=50 data-nosnippet>50</a> } <span class="kw">else </span>{
<a href=#51 id=51 data-nosnippet>51</a> <span class="comment">// just 1 byte representing 0 len
<a href=#52 id=52 data-nosnippet>52</a> </span>len += <span class="number">1</span>;
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a> len += <span class="self">self</span>.payload.len();
<a href=#56 id=56 data-nosnippet>56</a> len
<a href=#57 id=57 data-nosnippet>57</a> }
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;Publish, Error&gt; {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>qos_num = (fixed_header.byte1 &amp; <span class="number">0b0110</span>) &gt;&gt; <span class="number">1</span>;
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>qos = qos(qos_num).ok_or(Error::InvalidQoS(qos_num))<span class="question-mark">?</span>;
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span>dup = (fixed_header.byte1 &amp; <span class="number">0b1000</span>) != <span class="number">0</span>;
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>retain = (fixed_header.byte1 &amp; <span class="number">0b0001</span>) != <span class="number">0</span>;
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#66 id=66 data-nosnippet>66</a> bytes.advance(variable_header_index);
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>topic = read_mqtt_bytes(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="comment">// Packet identifier exists where QoS &gt; 0
<a href=#70 id=70 data-nosnippet>70</a> </span><span class="kw">let </span>pkid = <span class="kw">match </span>qos {
<a href=#71 id=71 data-nosnippet>71</a> QoS::AtMostOnce =&gt; <span class="number">0</span>,
<a href=#72 id=72 data-nosnippet>72</a> QoS::AtLeastOnce | QoS::ExactlyOnce =&gt; read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>,
<a href=#73 id=73 data-nosnippet>73</a> };
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">if </span>qos != QoS::AtMostOnce &amp;&amp; pkid == <span class="number">0 </span>{
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PacketIdZero);
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw">let </span>properties = PublishProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>publish = Publish {
<a href=#81 id=81 data-nosnippet>81</a> dup,
<a href=#82 id=82 data-nosnippet>82</a> retain,
<a href=#83 id=83 data-nosnippet>83</a> qos,
<a href=#84 id=84 data-nosnippet>84</a> pkid,
<a href=#85 id=85 data-nosnippet>85</a> topic,
<a href=#86 id=86 data-nosnippet>86</a> payload: bytes,
<a href=#87 id=87 data-nosnippet>87</a> properties,
<a href=#88 id=88 data-nosnippet>88</a> };
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> <span class="prelude-val">Ok</span>(publish)
<a href=#91 id=91 data-nosnippet>91</a> }
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">let </span>dup = <span class="self">self</span>.dup <span class="kw">as </span>u8;
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>qos = <span class="self">self</span>.qos <span class="kw">as </span>u8;
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">let </span>retain = <span class="self">self</span>.retain <span class="kw">as </span>u8;
<a href=#99 id=99 data-nosnippet>99</a> buffer.put_u8(<span class="number">0b0011_0000 </span>| retain | qos &lt;&lt; <span class="number">1 </span>| dup &lt;&lt; <span class="number">3</span>);
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#102 id=102 data-nosnippet>102</a> write_mqtt_bytes(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.topic);
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">if </span><span class="self">self</span>.qos != QoS::AtMostOnce {
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>pkid = <span class="self">self</span>.pkid;
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">if </span>pkid == <span class="number">0 </span>{
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PacketIdZero);
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> buffer.put_u16(pkid);
<a href=#111 id=111 data-nosnippet>111</a> }
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#114 id=114 data-nosnippet>114</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#115 id=115 data-nosnippet>115</a> } <span class="kw">else </span>{
<a href=#116 id=116 data-nosnippet>116</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.payload);
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>}
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, Default)]
<a href=#126 id=126 data-nosnippet>126</a></span><span class="kw">pub struct </span>PublishProperties {
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">pub </span>payload_format_indicator: <span class="prelude-ty">Option</span>&lt;u8&gt;,
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">pub </span>message_expiry_interval: <span class="prelude-ty">Option</span>&lt;u32&gt;,
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">pub </span>topic_alias: <span class="prelude-ty">Option</span>&lt;u16&gt;,
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">pub </span>response_topic: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">pub </span>correlation_data: <span class="prelude-ty">Option</span>&lt;Bytes&gt;,
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">pub </span>subscription_identifiers: Vec&lt;usize&gt;,
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">pub </span>content_type: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#135 id=135 data-nosnippet>135</a>}
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a><span class="kw">impl </span>PublishProperties {
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">if </span><span class="self">self</span>.payload_format_indicator.is_some() {
<a href=#142 id=142 data-nosnippet>142</a> len += <span class="number">1 </span>+ <span class="number">1</span>;
<a href=#143 id=143 data-nosnippet>143</a> }
<a href=#144 id=144 data-nosnippet>144</a>
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">if </span><span class="self">self</span>.message_expiry_interval.is_some() {
<a href=#146 id=146 data-nosnippet>146</a> len += <span class="number">1 </span>+ <span class="number">4</span>;
<a href=#147 id=147 data-nosnippet>147</a> }
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw">if </span><span class="self">self</span>.topic_alias.is_some() {
<a href=#150 id=150 data-nosnippet>150</a> len += <span class="number">1 </span>+ <span class="number">2</span>;
<a href=#151 id=151 data-nosnippet>151</a> }
<a href=#152 id=152 data-nosnippet>152</a>
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_topic {
<a href=#154 id=154 data-nosnippet>154</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ topic.len()
<a href=#155 id=155 data-nosnippet>155</a> }
<a href=#156 id=156 data-nosnippet>156</a>
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = <span class="kw-2">&amp;</span><span class="self">self</span>.correlation_data {
<a href=#158 id=158 data-nosnippet>158</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ data.len()
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a>
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#162 id=162 data-nosnippet>162</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#163 id=163 data-nosnippet>163</a> }
<a href=#164 id=164 data-nosnippet>164</a>
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">for </span>id <span class="kw">in </span><span class="self">self</span>.subscription_identifiers.iter() {
<a href=#166 id=166 data-nosnippet>166</a> len += <span class="number">1 </span>+ len_len(<span class="kw-2">*</span>id);
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(typ) = <span class="kw-2">&amp;</span><span class="self">self</span>.content_type {
<a href=#170 id=170 data-nosnippet>170</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ typ.len()
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a>
<a href=#173 id=173 data-nosnippet>173</a> len
<a href=#174 id=174 data-nosnippet>174</a> }
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;PublishProperties&gt;, Error&gt; {
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw">let </span><span class="kw-2">mut </span>payload_format_indicator = <span class="prelude-val">None</span>;
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">let </span><span class="kw-2">mut </span>message_expiry_interval = <span class="prelude-val">None</span>;
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">let </span><span class="kw-2">mut </span>topic_alias = <span class="prelude-val">None</span>;
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">let </span><span class="kw-2">mut </span>response_topic = <span class="prelude-val">None</span>;
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">let </span><span class="kw-2">mut </span>correlation_data = <span class="prelude-val">None</span>;
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span><span class="kw-2">mut </span>subscription_identifiers = Vec::new();
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">let </span><span class="kw-2">mut </span>content_type = <span class="prelude-val">None</span>;
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#187 id=187 data-nosnippet>187</a> bytes.advance(properties_len_len);
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#193 id=193 data-nosnippet>193</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#194 id=194 data-nosnippet>194</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#195 id=195 data-nosnippet>195</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#196 id=196 data-nosnippet>196</a> cursor += <span class="number">1</span>;
<a href=#197 id=197 data-nosnippet>197</a>
<a href=#198 id=198 data-nosnippet>198</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#199 id=199 data-nosnippet>199</a> PropertyType::PayloadFormatIndicator =&gt; {
<a href=#200 id=200 data-nosnippet>200</a> payload_format_indicator = <span class="prelude-val">Some</span>(read_u8(bytes)<span class="question-mark">?</span>);
<a href=#201 id=201 data-nosnippet>201</a> cursor += <span class="number">1</span>;
<a href=#202 id=202 data-nosnippet>202</a> }
<a href=#203 id=203 data-nosnippet>203</a> PropertyType::MessageExpiryInterval =&gt; {
<a href=#204 id=204 data-nosnippet>204</a> message_expiry_interval = <span class="prelude-val">Some</span>(read_u32(bytes)<span class="question-mark">?</span>);
<a href=#205 id=205 data-nosnippet>205</a> cursor += <span class="number">4</span>;
<a href=#206 id=206 data-nosnippet>206</a> }
<a href=#207 id=207 data-nosnippet>207</a> PropertyType::TopicAlias =&gt; {
<a href=#208 id=208 data-nosnippet>208</a> topic_alias = <span class="prelude-val">Some</span>(read_u16(bytes)<span class="question-mark">?</span>);
<a href=#209 id=209 data-nosnippet>209</a> cursor += <span class="number">2</span>;
<a href=#210 id=210 data-nosnippet>210</a> }
<a href=#211 id=211 data-nosnippet>211</a> PropertyType::ResponseTopic =&gt; {
<a href=#212 id=212 data-nosnippet>212</a> <span class="kw">let </span>topic = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#213 id=213 data-nosnippet>213</a> cursor += <span class="number">2 </span>+ topic.len();
<a href=#214 id=214 data-nosnippet>214</a> response_topic = <span class="prelude-val">Some</span>(topic);
<a href=#215 id=215 data-nosnippet>215</a> }
<a href=#216 id=216 data-nosnippet>216</a> PropertyType::CorrelationData =&gt; {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span>data = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#218 id=218 data-nosnippet>218</a> cursor += <span class="number">2 </span>+ data.len();
<a href=#219 id=219 data-nosnippet>219</a> correlation_data = <span class="prelude-val">Some</span>(data);
<a href=#220 id=220 data-nosnippet>220</a> }
<a href=#221 id=221 data-nosnippet>221</a> PropertyType::UserProperty =&gt; {
<a href=#222 id=222 data-nosnippet>222</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#224 id=224 data-nosnippet>224</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#225 id=225 data-nosnippet>225</a> user_properties.push((key, value));
<a href=#226 id=226 data-nosnippet>226</a> }
<a href=#227 id=227 data-nosnippet>227</a> PropertyType::SubscriptionIdentifier =&gt; {
<a href=#228 id=228 data-nosnippet>228</a> <span class="kw">let </span>(id_len, id) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#229 id=229 data-nosnippet>229</a> cursor += <span class="number">1 </span>+ id_len;
<a href=#230 id=230 data-nosnippet>230</a> bytes.advance(id_len);
<a href=#231 id=231 data-nosnippet>231</a> subscription_identifiers.push(id);
<a href=#232 id=232 data-nosnippet>232</a> }
<a href=#233 id=233 data-nosnippet>233</a> PropertyType::ContentType =&gt; {
<a href=#234 id=234 data-nosnippet>234</a> <span class="kw">let </span>typ = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#235 id=235 data-nosnippet>235</a> cursor += <span class="number">2 </span>+ typ.len();
<a href=#236 id=236 data-nosnippet>236</a> content_type = <span class="prelude-val">Some</span>(typ);
<a href=#237 id=237 data-nosnippet>237</a> }
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#239 id=239 data-nosnippet>239</a> }
<a href=#240 id=240 data-nosnippet>240</a> }
<a href=#241 id=241 data-nosnippet>241</a>
<a href=#242 id=242 data-nosnippet>242</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(PublishProperties {
<a href=#243 id=243 data-nosnippet>243</a> payload_format_indicator,
<a href=#244 id=244 data-nosnippet>244</a> message_expiry_interval,
<a href=#245 id=245 data-nosnippet>245</a> topic_alias,
<a href=#246 id=246 data-nosnippet>246</a> response_topic,
<a href=#247 id=247 data-nosnippet>247</a> correlation_data,
<a href=#248 id=248 data-nosnippet>248</a> user_properties,
<a href=#249 id=249 data-nosnippet>249</a> subscription_identifiers,
<a href=#250 id=250 data-nosnippet>250</a> content_type,
<a href=#251 id=251 data-nosnippet>251</a> }))
<a href=#252 id=252 data-nosnippet>252</a> }
<a href=#253 id=253 data-nosnippet>253</a>
<a href=#254 id=254 data-nosnippet>254</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#255 id=255 data-nosnippet>255</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#256 id=256 data-nosnippet>256</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#257 id=257 data-nosnippet>257</a>
<a href=#258 id=258 data-nosnippet>258</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(payload_format_indicator) = <span class="self">self</span>.payload_format_indicator {
<a href=#259 id=259 data-nosnippet>259</a> buffer.put_u8(PropertyType::PayloadFormatIndicator <span class="kw">as </span>u8);
<a href=#260 id=260 data-nosnippet>260</a> buffer.put_u8(payload_format_indicator);
<a href=#261 id=261 data-nosnippet>261</a> }
<a href=#262 id=262 data-nosnippet>262</a>
<a href=#263 id=263 data-nosnippet>263</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(message_expiry_interval) = <span class="self">self</span>.message_expiry_interval {
<a href=#264 id=264 data-nosnippet>264</a> buffer.put_u8(PropertyType::MessageExpiryInterval <span class="kw">as </span>u8);
<a href=#265 id=265 data-nosnippet>265</a> buffer.put_u32(message_expiry_interval);
<a href=#266 id=266 data-nosnippet>266</a> }
<a href=#267 id=267 data-nosnippet>267</a>
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic_alias) = <span class="self">self</span>.topic_alias {
<a href=#269 id=269 data-nosnippet>269</a> buffer.put_u8(PropertyType::TopicAlias <span class="kw">as </span>u8);
<a href=#270 id=270 data-nosnippet>270</a> buffer.put_u16(topic_alias);
<a href=#271 id=271 data-nosnippet>271</a> }
<a href=#272 id=272 data-nosnippet>272</a>
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(topic) = <span class="kw-2">&amp;</span><span class="self">self</span>.response_topic {
<a href=#274 id=274 data-nosnippet>274</a> buffer.put_u8(PropertyType::ResponseTopic <span class="kw">as </span>u8);
<a href=#275 id=275 data-nosnippet>275</a> write_mqtt_string(buffer, topic);
<a href=#276 id=276 data-nosnippet>276</a> }
<a href=#277 id=277 data-nosnippet>277</a>
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = <span class="kw-2">&amp;</span><span class="self">self</span>.correlation_data {
<a href=#279 id=279 data-nosnippet>279</a> buffer.put_u8(PropertyType::CorrelationData <span class="kw">as </span>u8);
<a href=#280 id=280 data-nosnippet>280</a> write_mqtt_bytes(buffer, data);
<a href=#281 id=281 data-nosnippet>281</a> }
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#284 id=284 data-nosnippet>284</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#285 id=285 data-nosnippet>285</a> write_mqtt_string(buffer, key);
<a href=#286 id=286 data-nosnippet>286</a> write_mqtt_string(buffer, value);
<a href=#287 id=287 data-nosnippet>287</a> }
<a href=#288 id=288 data-nosnippet>288</a>
<a href=#289 id=289 data-nosnippet>289</a> <span class="kw">for </span>id <span class="kw">in </span><span class="self">self</span>.subscription_identifiers.iter() {
<a href=#290 id=290 data-nosnippet>290</a> buffer.put_u8(PropertyType::SubscriptionIdentifier <span class="kw">as </span>u8);
<a href=#291 id=291 data-nosnippet>291</a> write_remaining_length(buffer, <span class="kw-2">*</span>id)<span class="question-mark">?</span>;
<a href=#292 id=292 data-nosnippet>292</a> }
<a href=#293 id=293 data-nosnippet>293</a>
<a href=#294 id=294 data-nosnippet>294</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(typ) = <span class="kw-2">&amp;</span><span class="self">self</span>.content_type {
<a href=#295 id=295 data-nosnippet>295</a> buffer.put_u8(PropertyType::ContentType <span class="kw">as </span>u8);
<a href=#296 id=296 data-nosnippet>296</a> write_mqtt_string(buffer, typ);
<a href=#297 id=297 data-nosnippet>297</a> }
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a> <span class="prelude-val">Ok</span>(())
<a href=#300 id=300 data-nosnippet>300</a> }
<a href=#301 id=301 data-nosnippet>301</a>}
<a href=#302 id=302 data-nosnippet>302</a>
<a href=#303 id=303 data-nosnippet>303</a><span class="attr">#[cfg(test)]
<a href=#304 id=304 data-nosnippet>304</a></span><span class="kw">mod </span>test {
<a href=#305 id=305 data-nosnippet>305</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#306 id=306 data-nosnippet>306</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#307 id=307 data-nosnippet>307</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a> <span class="attr">#[test]
<a href=#311 id=311 data-nosnippet>311</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#312 id=312 data-nosnippet>312</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#313 id=313 data-nosnippet>313</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#314 id=314 data-nosnippet>314</a> // remaining_length field in the packet be 2 bytes long.
<a href=#315 id=315 data-nosnippet>315</a> </span><span class="kw">let </span>publish_props = PublishProperties {
<a href=#316 id=316 data-nosnippet>316</a> payload_format_indicator: <span class="prelude-val">None</span>,
<a href=#317 id=317 data-nosnippet>317</a> message_expiry_interval: <span class="prelude-val">None</span>,
<a href=#318 id=318 data-nosnippet>318</a> topic_alias: <span class="prelude-val">None</span>,
<a href=#319 id=319 data-nosnippet>319</a> response_topic: <span class="prelude-val">None</span>,
<a href=#320 id=320 data-nosnippet>320</a> correlation_data: <span class="prelude-val">None</span>,
<a href=#321 id=321 data-nosnippet>321</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#322 id=322 data-nosnippet>322</a> subscription_identifiers: <span class="macro">vec!</span>[<span class="number">1</span>],
<a href=#323 id=323 data-nosnippet>323</a> content_type: <span class="prelude-val">None</span>,
<a href=#324 id=324 data-nosnippet>324</a> };
<a href=#325 id=325 data-nosnippet>325</a>
<a href=#326 id=326 data-nosnippet>326</a> <span class="kw">let </span>publish_pkt = Publish::new(
<a href=#327 id=327 data-nosnippet>327</a> <span class="string">"hello/world"</span>,
<a href=#328 id=328 data-nosnippet>328</a> QoS::AtMostOnce,
<a href=#329 id=329 data-nosnippet>329</a> <span class="macro">vec!</span>[<span class="number">1</span>; <span class="number">10</span>],
<a href=#330 id=330 data-nosnippet>330</a> <span class="prelude-val">Some</span>(publish_props),
<a href=#331 id=331 data-nosnippet>331</a> );
<a href=#332 id=332 data-nosnippet>332</a>
<a href=#333 id=333 data-nosnippet>333</a> <span class="kw">let </span>size_from_size = publish_pkt.size();
<a href=#334 id=334 data-nosnippet>334</a> <span class="kw">let </span>size_from_write = publish_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#335 id=335 data-nosnippet>335</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#336 id=336 data-nosnippet>336</a>
<a href=#337 id=337 data-nosnippet>337</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#338 id=338 data-nosnippet>338</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#339 id=339 data-nosnippet>339</a> }
<a href=#340 id=340 data-nosnippet>340</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,253 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/pubrec.rs`."><title>pubrec.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>pubrec.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Return code in PubRec
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a>#[repr(u8)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub enum </span>PubRecReason {
<a href=#8 id=8 data-nosnippet>8</a> Success,
<a href=#9 id=9 data-nosnippet>9</a> NoMatchingSubscribers,
<a href=#10 id=10 data-nosnippet>10</a> UnspecifiedError,
<a href=#11 id=11 data-nosnippet>11</a> ImplementationSpecificError,
<a href=#12 id=12 data-nosnippet>12</a> NotAuthorized,
<a href=#13 id=13 data-nosnippet>13</a> TopicNameInvalid,
<a href=#14 id=14 data-nosnippet>14</a> PacketIdentifierInUse,
<a href=#15 id=15 data-nosnippet>15</a> QuotaExceeded,
<a href=#16 id=16 data-nosnippet>16</a> PayloadFormatInvalid,
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="doccomment">/// Acknowledgement to QoS1 publish
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">pub struct </span>PubRec {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">pub </span>pkid: u16,
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">pub </span>reason: PubRecReason,
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;PubRecProperties&gt;,
<a href=#25 id=25 data-nosnippet>25</a>}
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">impl </span>PubRec {
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">pub fn </span>new(pkid: u16, properties: <span class="prelude-ty">Option</span>&lt;PubRecProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#29 id=29 data-nosnippet>29</a> <span class="self">Self </span>{
<a href=#30 id=30 data-nosnippet>30</a> pkid,
<a href=#31 id=31 data-nosnippet>31</a> reason: PubRecReason::Success,
<a href=#32 id=32 data-nosnippet>32</a> properties,
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#41 id=41 data-nosnippet>41</a> }
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="number">1</span>; <span class="comment">// pkid + reason
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
<a href=#47 id=47 data-nosnippet>47</a> // and there are no Properties. In this case the PUBREC has a Remaining Length of 2.
<a href=#48 id=48 data-nosnippet>48</a> // &lt;https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134&gt;
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubRecReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">return </span><span class="number">2</span>;
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">let </span>properties_len = p.len();
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#56 id=56 data-nosnippet>56</a> len += properties_len_len + properties_len;
<a href=#57 id=57 data-nosnippet>57</a> } <span class="kw">else </span>{
<a href=#58 id=58 data-nosnippet>58</a> len += <span class="number">1
<a href=#59 id=59 data-nosnippet>59</a> </span>}
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> len
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a>
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;PubRec, Error&gt; {
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#66 id=66 data-nosnippet>66</a> bytes.advance(variable_header_index);
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRec {
<a href=#70 id=70 data-nosnippet>70</a> pkid,
<a href=#71 id=71 data-nosnippet>71</a> reason: PubRecReason::Success,
<a href=#72 id=72 data-nosnippet>72</a> properties: <span class="prelude-val">None</span>,
<a href=#73 id=73 data-nosnippet>73</a> });
<a href=#74 id=74 data-nosnippet>74</a> }
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>ack_reason = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRec {
<a href=#79 id=79 data-nosnippet>79</a> pkid,
<a href=#80 id=80 data-nosnippet>80</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#81 id=81 data-nosnippet>81</a> properties: <span class="prelude-val">None</span>,
<a href=#82 id=82 data-nosnippet>82</a> });
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span>properties = PubRecProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span>puback = PubRec {
<a href=#87 id=87 data-nosnippet>87</a> pkid,
<a href=#88 id=88 data-nosnippet>88</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#89 id=89 data-nosnippet>89</a> properties,
<a href=#90 id=90 data-nosnippet>90</a> };
<a href=#91 id=91 data-nosnippet>91</a> <span class="prelude-val">Ok</span>(puback)
<a href=#92 id=92 data-nosnippet>92</a> }
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#96 id=96 data-nosnippet>96</a> buffer.put_u8(<span class="number">0x50</span>);
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#98 id=98 data-nosnippet>98</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a> <span class="comment">// If there are no properties during success, sending reason code is optional
<a href=#101 id=101 data-nosnippet>101</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubRecReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">4</span>);
<a href=#103 id=103 data-nosnippet>103</a> }
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> buffer.put_u8(code(<span class="self">self</span>.reason));
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#108 id=108 data-nosnippet>108</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#109 id=109 data-nosnippet>109</a> } <span class="kw">else </span>{
<a href=#110 id=110 data-nosnippet>110</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#111 id=111 data-nosnippet>111</a> }
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#114 id=114 data-nosnippet>114</a> }
<a href=#115 id=115 data-nosnippet>115</a>}
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#118 id=118 data-nosnippet>118</a></span><span class="kw">pub struct </span>PubRecProperties {
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#121 id=121 data-nosnippet>121</a>}
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a><span class="kw">impl </span>PubRecProperties {
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#128 id=128 data-nosnippet>128</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#132 id=132 data-nosnippet>132</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#133 id=133 data-nosnippet>133</a> }
<a href=#134 id=134 data-nosnippet>134</a>
<a href=#135 id=135 data-nosnippet>135</a> len
<a href=#136 id=136 data-nosnippet>136</a> }
<a href=#137 id=137 data-nosnippet>137</a>
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;PubRecProperties&gt;, Error&gt; {
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#141 id=141 data-nosnippet>141</a>
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#143 id=143 data-nosnippet>143</a> bytes.advance(properties_len_len);
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#146 id=146 data-nosnippet>146</a> }
<a href=#147 id=147 data-nosnippet>147</a>
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#149 id=149 data-nosnippet>149</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#152 id=152 data-nosnippet>152</a> cursor += <span class="number">1</span>;
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#155 id=155 data-nosnippet>155</a> PropertyType::ReasonString =&gt; {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#157 id=157 data-nosnippet>157</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#158 id=158 data-nosnippet>158</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a> PropertyType::UserProperty =&gt; {
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#163 id=163 data-nosnippet>163</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#164 id=164 data-nosnippet>164</a> user_properties.push((key, value));
<a href=#165 id=165 data-nosnippet>165</a> }
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(PubRecProperties {
<a href=#171 id=171 data-nosnippet>171</a> reason_string,
<a href=#172 id=172 data-nosnippet>172</a> user_properties,
<a href=#173 id=173 data-nosnippet>173</a> }))
<a href=#174 id=174 data-nosnippet>174</a> }
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#178 id=178 data-nosnippet>178</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#179 id=179 data-nosnippet>179</a>
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#181 id=181 data-nosnippet>181</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#182 id=182 data-nosnippet>182</a> write_mqtt_string(buffer, reason);
<a href=#183 id=183 data-nosnippet>183</a> }
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#186 id=186 data-nosnippet>186</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#187 id=187 data-nosnippet>187</a> write_mqtt_string(buffer, key);
<a href=#188 id=188 data-nosnippet>188</a> write_mqtt_string(buffer, value);
<a href=#189 id=189 data-nosnippet>189</a> }
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="prelude-val">Ok</span>(())
<a href=#192 id=192 data-nosnippet>192</a> }
<a href=#193 id=193 data-nosnippet>193</a>}
<a href=#194 id=194 data-nosnippet>194</a>
<a href=#195 id=195 data-nosnippet>195</a><span class="doccomment">/// Connection return code type
<a href=#196 id=196 data-nosnippet>196</a></span><span class="kw">fn </span>reason(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;PubRecReason, Error&gt; {
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#198 id=198 data-nosnippet>198</a> <span class="number">0 </span>=&gt; PubRecReason::Success,
<a href=#199 id=199 data-nosnippet>199</a> <span class="number">16 </span>=&gt; PubRecReason::NoMatchingSubscribers,
<a href=#200 id=200 data-nosnippet>200</a> <span class="number">128 </span>=&gt; PubRecReason::UnspecifiedError,
<a href=#201 id=201 data-nosnippet>201</a> <span class="number">131 </span>=&gt; PubRecReason::ImplementationSpecificError,
<a href=#202 id=202 data-nosnippet>202</a> <span class="number">135 </span>=&gt; PubRecReason::NotAuthorized,
<a href=#203 id=203 data-nosnippet>203</a> <span class="number">144 </span>=&gt; PubRecReason::TopicNameInvalid,
<a href=#204 id=204 data-nosnippet>204</a> <span class="number">145 </span>=&gt; PubRecReason::PacketIdentifierInUse,
<a href=#205 id=205 data-nosnippet>205</a> <span class="number">151 </span>=&gt; PubRecReason::QuotaExceeded,
<a href=#206 id=206 data-nosnippet>206</a> <span class="number">153 </span>=&gt; PubRecReason::PayloadFormatInvalid,
<a href=#207 id=207 data-nosnippet>207</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<a href=#208 id=208 data-nosnippet>208</a> };
<a href=#209 id=209 data-nosnippet>209</a>
<a href=#210 id=210 data-nosnippet>210</a> <span class="prelude-val">Ok</span>(code)
<a href=#211 id=211 data-nosnippet>211</a>}
<a href=#212 id=212 data-nosnippet>212</a>
<a href=#213 id=213 data-nosnippet>213</a><span class="kw">fn </span>code(reason: PubRecReason) -&gt; u8 {
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">match </span>reason {
<a href=#215 id=215 data-nosnippet>215</a> PubRecReason::Success =&gt; <span class="number">0</span>,
<a href=#216 id=216 data-nosnippet>216</a> PubRecReason::NoMatchingSubscribers =&gt; <span class="number">16</span>,
<a href=#217 id=217 data-nosnippet>217</a> PubRecReason::UnspecifiedError =&gt; <span class="number">128</span>,
<a href=#218 id=218 data-nosnippet>218</a> PubRecReason::ImplementationSpecificError =&gt; <span class="number">131</span>,
<a href=#219 id=219 data-nosnippet>219</a> PubRecReason::NotAuthorized =&gt; <span class="number">135</span>,
<a href=#220 id=220 data-nosnippet>220</a> PubRecReason::TopicNameInvalid =&gt; <span class="number">144</span>,
<a href=#221 id=221 data-nosnippet>221</a> PubRecReason::PacketIdentifierInUse =&gt; <span class="number">145</span>,
<a href=#222 id=222 data-nosnippet>222</a> PubRecReason::QuotaExceeded =&gt; <span class="number">151</span>,
<a href=#223 id=223 data-nosnippet>223</a> PubRecReason::PayloadFormatInvalid =&gt; <span class="number">153</span>,
<a href=#224 id=224 data-nosnippet>224</a> }
<a href=#225 id=225 data-nosnippet>225</a>}
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a><span class="attr">#[cfg(test)]
<a href=#228 id=228 data-nosnippet>228</a></span><span class="kw">mod </span>test {
<a href=#229 id=229 data-nosnippet>229</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#231 id=231 data-nosnippet>231</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a> <span class="attr">#[test]
<a href=#235 id=235 data-nosnippet>235</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#236 id=236 data-nosnippet>236</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#237 id=237 data-nosnippet>237</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#238 id=238 data-nosnippet>238</a> // remaining_length field in the packet be 2 bytes long.
<a href=#239 id=239 data-nosnippet>239</a> </span><span class="kw">let </span>pubrec_props = PubRecProperties {
<a href=#240 id=240 data-nosnippet>240</a> reason_string: <span class="prelude-val">None</span>,
<a href=#241 id=241 data-nosnippet>241</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#242 id=242 data-nosnippet>242</a> };
<a href=#243 id=243 data-nosnippet>243</a>
<a href=#244 id=244 data-nosnippet>244</a> <span class="kw">let </span>pubrec_pkt = PubRec::new(<span class="number">1</span>, <span class="prelude-val">Some</span>(pubrec_props));
<a href=#245 id=245 data-nosnippet>245</a>
<a href=#246 id=246 data-nosnippet>246</a> <span class="kw">let </span>size_from_size = pubrec_pkt.size();
<a href=#247 id=247 data-nosnippet>247</a> <span class="kw">let </span>size_from_write = pubrec_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#249 id=249 data-nosnippet>249</a>
<a href=#250 id=250 data-nosnippet>250</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#251 id=251 data-nosnippet>251</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#252 id=252 data-nosnippet>252</a> }
<a href=#253 id=253 data-nosnippet>253</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,238 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/pubrel.rs`."><title>pubrel.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>pubrel.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Return code in PubRel
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a>#[repr(u8)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub enum </span>PubRelReason {
<a href=#8 id=8 data-nosnippet>8</a> Success,
<a href=#9 id=9 data-nosnippet>9</a> PacketIdentifierNotFound,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="doccomment">/// QoS2 Publish release, in response to PUBREC packet
<a href=#13 id=13 data-nosnippet>13</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#14 id=14 data-nosnippet>14</a></span><span class="kw">pub struct </span>PubRel {
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub </span>pkid: u16,
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">pub </span>reason: PubRelReason,
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;PubRelProperties&gt;,
<a href=#18 id=18 data-nosnippet>18</a>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">impl </span>PubRel {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub fn </span>new(pkid: u16, properties: <span class="prelude-ty">Option</span>&lt;PubRelProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#22 id=22 data-nosnippet>22</a> <span class="self">Self </span>{
<a href=#23 id=23 data-nosnippet>23</a> pkid,
<a href=#24 id=24 data-nosnippet>24</a> reason: PubRelReason::Success,
<a href=#25 id=25 data-nosnippet>25</a> properties,
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#30 id=30 data-nosnippet>30</a> <span class="comment">// If there are no properties during success, sending reason code is optional
<a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubRelReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">return </span><span class="number">4</span>;
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#37 id=37 data-nosnippet>37</a>
<a href=#38 id=38 data-nosnippet>38</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="number">1</span>; <span class="comment">// pkid + reason
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a> // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
<a href=#45 id=45 data-nosnippet>45</a> // and there are no Properties. In this case the PUBREL has a Remaining Length of 2.
<a href=#46 id=46 data-nosnippet>46</a> // &lt;https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144&gt;
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubRelReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">return </span><span class="number">2</span>;
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>properties_len = p.len();
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#54 id=54 data-nosnippet>54</a> len += properties_len_len + properties_len;
<a href=#55 id=55 data-nosnippet>55</a> } <span class="kw">else </span>{
<a href=#56 id=56 data-nosnippet>56</a> len += <span class="number">1</span>;
<a href=#57 id=57 data-nosnippet>57</a> }
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> len
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;PubRel, Error&gt; {
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#64 id=64 data-nosnippet>64</a> bytes.advance(variable_header_index);
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRel {
<a href=#68 id=68 data-nosnippet>68</a> pkid,
<a href=#69 id=69 data-nosnippet>69</a> reason: PubRelReason::Success,
<a href=#70 id=70 data-nosnippet>70</a> properties: <span class="prelude-val">None</span>,
<a href=#71 id=71 data-nosnippet>71</a> });
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>ack_reason = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRel {
<a href=#77 id=77 data-nosnippet>77</a> pkid,
<a href=#78 id=78 data-nosnippet>78</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#79 id=79 data-nosnippet>79</a> properties: <span class="prelude-val">None</span>,
<a href=#80 id=80 data-nosnippet>80</a> });
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>properties = PubRelProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span>puback = PubRel {
<a href=#85 id=85 data-nosnippet>85</a> pkid,
<a href=#86 id=86 data-nosnippet>86</a> reason: reason(ack_reason)<span class="question-mark">?</span>,
<a href=#87 id=87 data-nosnippet>87</a> properties,
<a href=#88 id=88 data-nosnippet>88</a> };
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> <span class="prelude-val">Ok</span>(puback)
<a href=#91 id=91 data-nosnippet>91</a> }
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#95 id=95 data-nosnippet>95</a> buffer.put_u8(<span class="number">0x62</span>);
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#97 id=97 data-nosnippet>97</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> <span class="comment">// If there are no properties during success, sending reason code is optional
<a href=#100 id=100 data-nosnippet>100</a> </span><span class="kw">if </span><span class="self">self</span>.reason == PubRelReason::Success &amp;&amp; <span class="self">self</span>.properties.is_none() {
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">4</span>);
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> buffer.put_u8(code(<span class="self">self</span>.reason));
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#107 id=107 data-nosnippet>107</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#108 id=108 data-nosnippet>108</a> } <span class="kw">else </span>{
<a href=#109 id=109 data-nosnippet>109</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>
<a href=#112 id=112 data-nosnippet>112</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#113 id=113 data-nosnippet>113</a> }
<a href=#114 id=114 data-nosnippet>114</a>}
<a href=#115 id=115 data-nosnippet>115</a>
<a href=#116 id=116 data-nosnippet>116</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#117 id=117 data-nosnippet>117</a></span><span class="kw">pub struct </span>PubRelProperties {
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#120 id=120 data-nosnippet>120</a>}
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a><span class="kw">impl </span>PubRelProperties {
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#127 id=127 data-nosnippet>127</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#128 id=128 data-nosnippet>128</a> }
<a href=#129 id=129 data-nosnippet>129</a>
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#131 id=131 data-nosnippet>131</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#132 id=132 data-nosnippet>132</a> }
<a href=#133 id=133 data-nosnippet>133</a>
<a href=#134 id=134 data-nosnippet>134</a> len
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;PubRelProperties&gt;, Error&gt; {
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#142 id=142 data-nosnippet>142</a> bytes.advance(properties_len_len);
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#148 id=148 data-nosnippet>148</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#149 id=149 data-nosnippet>149</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#151 id=151 data-nosnippet>151</a> cursor += <span class="number">1</span>;
<a href=#152 id=152 data-nosnippet>152</a>
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#154 id=154 data-nosnippet>154</a> PropertyType::ReasonString =&gt; {
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#156 id=156 data-nosnippet>156</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#157 id=157 data-nosnippet>157</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a> PropertyType::UserProperty =&gt; {
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#162 id=162 data-nosnippet>162</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#163 id=163 data-nosnippet>163</a> user_properties.push((key, value));
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#166 id=166 data-nosnippet>166</a> }
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(PubRelProperties {
<a href=#170 id=170 data-nosnippet>170</a> reason_string,
<a href=#171 id=171 data-nosnippet>171</a> user_properties,
<a href=#172 id=172 data-nosnippet>172</a> }))
<a href=#173 id=173 data-nosnippet>173</a> }
<a href=#174 id=174 data-nosnippet>174</a>
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#177 id=177 data-nosnippet>177</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#178 id=178 data-nosnippet>178</a>
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#180 id=180 data-nosnippet>180</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#181 id=181 data-nosnippet>181</a> write_mqtt_string(buffer, reason);
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#185 id=185 data-nosnippet>185</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#186 id=186 data-nosnippet>186</a> write_mqtt_string(buffer, key);
<a href=#187 id=187 data-nosnippet>187</a> write_mqtt_string(buffer, value);
<a href=#188 id=188 data-nosnippet>188</a> }
<a href=#189 id=189 data-nosnippet>189</a>
<a href=#190 id=190 data-nosnippet>190</a> <span class="prelude-val">Ok</span>(())
<a href=#191 id=191 data-nosnippet>191</a> }
<a href=#192 id=192 data-nosnippet>192</a>}
<a href=#193 id=193 data-nosnippet>193</a>
<a href=#194 id=194 data-nosnippet>194</a><span class="doccomment">/// Connection return code type
<a href=#195 id=195 data-nosnippet>195</a></span><span class="kw">fn </span>reason(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;PubRelReason, Error&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#197 id=197 data-nosnippet>197</a> <span class="number">0 </span>=&gt; PubRelReason::Success,
<a href=#198 id=198 data-nosnippet>198</a> <span class="number">146 </span>=&gt; PubRelReason::PacketIdentifierNotFound,
<a href=#199 id=199 data-nosnippet>199</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<a href=#200 id=200 data-nosnippet>200</a> };
<a href=#201 id=201 data-nosnippet>201</a>
<a href=#202 id=202 data-nosnippet>202</a> <span class="prelude-val">Ok</span>(code)
<a href=#203 id=203 data-nosnippet>203</a>}
<a href=#204 id=204 data-nosnippet>204</a>
<a href=#205 id=205 data-nosnippet>205</a><span class="kw">fn </span>code(reason: PubRelReason) -&gt; u8 {
<a href=#206 id=206 data-nosnippet>206</a> <span class="kw">match </span>reason {
<a href=#207 id=207 data-nosnippet>207</a> PubRelReason::Success =&gt; <span class="number">0</span>,
<a href=#208 id=208 data-nosnippet>208</a> PubRelReason::PacketIdentifierNotFound =&gt; <span class="number">146</span>,
<a href=#209 id=209 data-nosnippet>209</a> }
<a href=#210 id=210 data-nosnippet>210</a>}
<a href=#211 id=211 data-nosnippet>211</a>
<a href=#212 id=212 data-nosnippet>212</a><span class="attr">#[cfg(test)]
<a href=#213 id=213 data-nosnippet>213</a></span><span class="kw">mod </span>test {
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="attr">#[test]
<a href=#220 id=220 data-nosnippet>220</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#222 id=222 data-nosnippet>222</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#223 id=223 data-nosnippet>223</a> // remaining_length field in the packet be 2 bytes long.
<a href=#224 id=224 data-nosnippet>224</a> </span><span class="kw">let </span>pubrel_props = PubRelProperties {
<a href=#225 id=225 data-nosnippet>225</a> reason_string: <span class="prelude-val">None</span>,
<a href=#226 id=226 data-nosnippet>226</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#227 id=227 data-nosnippet>227</a> };
<a href=#228 id=228 data-nosnippet>228</a>
<a href=#229 id=229 data-nosnippet>229</a> <span class="kw">let </span>pubrel_pkt = PubRel::new(<span class="number">1</span>, <span class="prelude-val">Some</span>(pubrel_props));
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a> <span class="kw">let </span>size_from_size = pubrel_pkt.size();
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">let </span>size_from_write = pubrel_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#234 id=234 data-nosnippet>234</a>
<a href=#235 id=235 data-nosnippet>235</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#236 id=236 data-nosnippet>236</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#237 id=237 data-nosnippet>237</a> }
<a href=#238 id=238 data-nosnippet>238</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,240 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/suback.rs`."><title>suback.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>suback.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Acknowledgement to subscribe
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>SubAck {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw">pub </span>pkid: u16,
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>return_codes: Vec&lt;SubscribeReasonCode&gt;,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;SubAckProperties&gt;,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>SubAck {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="self">self</span>.return_codes.len();
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>properties_len = p.len();
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#19 id=19 data-nosnippet>19</a> len += properties_len_len + properties_len;
<a href=#20 id=20 data-nosnippet>20</a> } <span class="kw">else </span>{
<a href=#21 id=21 data-nosnippet>21</a> <span class="comment">// just 1 byte representing 0 len
<a href=#22 id=22 data-nosnippet>22</a> </span>len += <span class="number">1</span>;
<a href=#23 id=23 data-nosnippet>23</a> }
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> len
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;SubAck, Error&gt; {
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#37 id=37 data-nosnippet>37</a> bytes.advance(variable_header_index);
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>properties = SubAckProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if </span>!bytes.has_remaining() {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span><span class="kw-2">mut </span>return_codes = Vec::new();
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>return_code = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#49 id=49 data-nosnippet>49</a> return_codes.push(reason(return_code)<span class="question-mark">?</span>);
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>suback = SubAck {
<a href=#53 id=53 data-nosnippet>53</a> pkid,
<a href=#54 id=54 data-nosnippet>54</a> return_codes,
<a href=#55 id=55 data-nosnippet>55</a> properties,
<a href=#56 id=56 data-nosnippet>56</a> };
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">Ok</span>(suback)
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#62 id=62 data-nosnippet>62</a> buffer.put_u8(<span class="number">0x90</span>);
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#69 id=69 data-nosnippet>69</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#70 id=70 data-nosnippet>70</a> } <span class="kw">else </span>{
<a href=#71 id=71 data-nosnippet>71</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>p: Vec&lt;u8&gt; = <span class="self">self</span>.return_codes.iter().map(|<span class="kw-2">&amp;</span>c| code(c)).collect();
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span>p);
<a href=#77 id=77 data-nosnippet>77</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#78 id=78 data-nosnippet>78</a> }
<a href=#79 id=79 data-nosnippet>79</a>}
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#82 id=82 data-nosnippet>82</a></span><span class="kw">pub enum </span>SubscribeReasonCode {
<a href=#83 id=83 data-nosnippet>83</a> Success(QoS),
<a href=#84 id=84 data-nosnippet>84</a> Failure,
<a href=#85 id=85 data-nosnippet>85</a> Unspecified,
<a href=#86 id=86 data-nosnippet>86</a> ImplementationSpecific,
<a href=#87 id=87 data-nosnippet>87</a> NotAuthorized,
<a href=#88 id=88 data-nosnippet>88</a> TopicFilterInvalid,
<a href=#89 id=89 data-nosnippet>89</a> PkidInUse,
<a href=#90 id=90 data-nosnippet>90</a> QuotaExceeded,
<a href=#91 id=91 data-nosnippet>91</a> SharedSubscriptionsNotSupported,
<a href=#92 id=92 data-nosnippet>92</a> SubscriptionIdNotSupported,
<a href=#93 id=93 data-nosnippet>93</a> WildcardSubscriptionsNotSupported,
<a href=#94 id=94 data-nosnippet>94</a>}
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#97 id=97 data-nosnippet>97</a></span><span class="kw">pub struct </span>SubAckProperties {
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#100 id=100 data-nosnippet>100</a>}
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a><span class="kw">impl </span>SubAckProperties {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#107 id=107 data-nosnippet>107</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#111 id=111 data-nosnippet>111</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#112 id=112 data-nosnippet>112</a> }
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a> len
<a href=#115 id=115 data-nosnippet>115</a> }
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;SubAckProperties&gt;, Error&gt; {
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#122 id=122 data-nosnippet>122</a> bytes.advance(properties_len_len);
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#128 id=128 data-nosnippet>128</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#129 id=129 data-nosnippet>129</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#131 id=131 data-nosnippet>131</a> cursor += <span class="number">1</span>;
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#134 id=134 data-nosnippet>134</a> PropertyType::ReasonString =&gt; {
<a href=#135 id=135 data-nosnippet>135</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#136 id=136 data-nosnippet>136</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#137 id=137 data-nosnippet>137</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a> PropertyType::UserProperty =&gt; {
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#142 id=142 data-nosnippet>142</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#143 id=143 data-nosnippet>143</a> user_properties.push((key, value));
<a href=#144 id=144 data-nosnippet>144</a> }
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#146 id=146 data-nosnippet>146</a> }
<a href=#147 id=147 data-nosnippet>147</a> }
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(SubAckProperties {
<a href=#150 id=150 data-nosnippet>150</a> reason_string,
<a href=#151 id=151 data-nosnippet>151</a> user_properties,
<a href=#152 id=152 data-nosnippet>152</a> }))
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#157 id=157 data-nosnippet>157</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#160 id=160 data-nosnippet>160</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#161 id=161 data-nosnippet>161</a> write_mqtt_string(buffer, reason);
<a href=#162 id=162 data-nosnippet>162</a> }
<a href=#163 id=163 data-nosnippet>163</a>
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#165 id=165 data-nosnippet>165</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#166 id=166 data-nosnippet>166</a> write_mqtt_string(buffer, key);
<a href=#167 id=167 data-nosnippet>167</a> write_mqtt_string(buffer, value);
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a> <span class="prelude-val">Ok</span>(())
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a>}
<a href=#173 id=173 data-nosnippet>173</a>
<a href=#174 id=174 data-nosnippet>174</a><span class="kw">fn </span>reason(code: u8) -&gt; <span class="prelude-ty">Result</span>&lt;SubscribeReasonCode, Error&gt; {
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span>v = <span class="kw">match </span>code {
<a href=#176 id=176 data-nosnippet>176</a> <span class="number">0 </span>=&gt; SubscribeReasonCode::Success(QoS::AtMostOnce),
<a href=#177 id=177 data-nosnippet>177</a> <span class="number">1 </span>=&gt; SubscribeReasonCode::Success(QoS::AtLeastOnce),
<a href=#178 id=178 data-nosnippet>178</a> <span class="number">2 </span>=&gt; SubscribeReasonCode::Success(QoS::ExactlyOnce),
<a href=#179 id=179 data-nosnippet>179</a> <span class="number">128 </span>=&gt; SubscribeReasonCode::Unspecified,
<a href=#180 id=180 data-nosnippet>180</a> <span class="number">131 </span>=&gt; SubscribeReasonCode::ImplementationSpecific,
<a href=#181 id=181 data-nosnippet>181</a> <span class="number">135 </span>=&gt; SubscribeReasonCode::NotAuthorized,
<a href=#182 id=182 data-nosnippet>182</a> <span class="number">143 </span>=&gt; SubscribeReasonCode::TopicFilterInvalid,
<a href=#183 id=183 data-nosnippet>183</a> <span class="number">145 </span>=&gt; SubscribeReasonCode::PkidInUse,
<a href=#184 id=184 data-nosnippet>184</a> <span class="number">151 </span>=&gt; SubscribeReasonCode::QuotaExceeded,
<a href=#185 id=185 data-nosnippet>185</a> <span class="number">158 </span>=&gt; SubscribeReasonCode::SharedSubscriptionsNotSupported,
<a href=#186 id=186 data-nosnippet>186</a> <span class="number">161 </span>=&gt; SubscribeReasonCode::SubscriptionIdNotSupported,
<a href=#187 id=187 data-nosnippet>187</a> <span class="number">162 </span>=&gt; SubscribeReasonCode::WildcardSubscriptionsNotSupported,
<a href=#188 id=188 data-nosnippet>188</a> v =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSubscribeReasonCode(v)),
<a href=#189 id=189 data-nosnippet>189</a> };
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="prelude-val">Ok</span>(v)
<a href=#192 id=192 data-nosnippet>192</a>}
<a href=#193 id=193 data-nosnippet>193</a>
<a href=#194 id=194 data-nosnippet>194</a><span class="kw">fn </span>code(value: SubscribeReasonCode) -&gt; u8 {
<a href=#195 id=195 data-nosnippet>195</a> <span class="kw">match </span>value {
<a href=#196 id=196 data-nosnippet>196</a> SubscribeReasonCode::Success(qos) =&gt; qos <span class="kw">as </span>u8,
<a href=#197 id=197 data-nosnippet>197</a> SubscribeReasonCode::Failure =&gt; <span class="number">0x80</span>,
<a href=#198 id=198 data-nosnippet>198</a> SubscribeReasonCode::Unspecified =&gt; <span class="number">128</span>,
<a href=#199 id=199 data-nosnippet>199</a> SubscribeReasonCode::ImplementationSpecific =&gt; <span class="number">131</span>,
<a href=#200 id=200 data-nosnippet>200</a> SubscribeReasonCode::NotAuthorized =&gt; <span class="number">135</span>,
<a href=#201 id=201 data-nosnippet>201</a> SubscribeReasonCode::TopicFilterInvalid =&gt; <span class="number">143</span>,
<a href=#202 id=202 data-nosnippet>202</a> SubscribeReasonCode::PkidInUse =&gt; <span class="number">145</span>,
<a href=#203 id=203 data-nosnippet>203</a> SubscribeReasonCode::QuotaExceeded =&gt; <span class="number">151</span>,
<a href=#204 id=204 data-nosnippet>204</a> SubscribeReasonCode::SharedSubscriptionsNotSupported =&gt; <span class="number">158</span>,
<a href=#205 id=205 data-nosnippet>205</a> SubscribeReasonCode::SubscriptionIdNotSupported =&gt; <span class="number">161</span>,
<a href=#206 id=206 data-nosnippet>206</a> SubscribeReasonCode::WildcardSubscriptionsNotSupported =&gt; <span class="number">162</span>,
<a href=#207 id=207 data-nosnippet>207</a> }
<a href=#208 id=208 data-nosnippet>208</a>}
<a href=#209 id=209 data-nosnippet>209</a>
<a href=#210 id=210 data-nosnippet>210</a><span class="attr">#[cfg(test)]
<a href=#211 id=211 data-nosnippet>211</a></span><span class="kw">mod </span>test {
<a href=#212 id=212 data-nosnippet>212</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#213 id=213 data-nosnippet>213</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#216 id=216 data-nosnippet>216</a>
<a href=#217 id=217 data-nosnippet>217</a> <span class="attr">#[test]
<a href=#218 id=218 data-nosnippet>218</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#220 id=220 data-nosnippet>220</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#221 id=221 data-nosnippet>221</a> // remaining_length field in the packet be 2 bytes long.
<a href=#222 id=222 data-nosnippet>222</a> </span><span class="kw">let </span>suback_props = SubAckProperties {
<a href=#223 id=223 data-nosnippet>223</a> reason_string: <span class="prelude-val">None</span>,
<a href=#224 id=224 data-nosnippet>224</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#225 id=225 data-nosnippet>225</a> };
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span>suback_pkt = SubAck {
<a href=#228 id=228 data-nosnippet>228</a> pkid: <span class="number">1</span>,
<a href=#229 id=229 data-nosnippet>229</a> return_codes: <span class="macro">vec!</span>[SubscribeReasonCode::Success(QoS::ExactlyOnce)],
<a href=#230 id=230 data-nosnippet>230</a> properties: <span class="prelude-val">Some</span>(suback_props),
<a href=#231 id=231 data-nosnippet>231</a> };
<a href=#232 id=232 data-nosnippet>232</a>
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">let </span>size_from_size = suback_pkt.size();
<a href=#234 id=234 data-nosnippet>234</a> <span class="kw">let </span>size_from_write = suback_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#235 id=235 data-nosnippet>235</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#236 id=236 data-nosnippet>236</a>
<a href=#237 id=237 data-nosnippet>237</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#238 id=238 data-nosnippet>238</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#239 id=239 data-nosnippet>239</a> }
<a href=#240 id=240 data-nosnippet>240</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,305 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/subscribe.rs`."><title>subscribe.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>subscribe.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, Bytes};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Subscription packet
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Default)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>Subscribe {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw">pub </span>pkid: u16,
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>filters: Vec&lt;Filter&gt;,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;SubscribeProperties&gt;,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>Subscribe {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub fn </span>new(filter: Filter, properties: <span class="prelude-ty">Option</span>&lt;SubscribeProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#14 id=14 data-nosnippet>14</a> <span class="self">Self </span>{
<a href=#15 id=15 data-nosnippet>15</a> filters: <span class="macro">vec!</span>[filter],
<a href=#16 id=16 data-nosnippet>16</a> properties,
<a href=#17 id=17 data-nosnippet>17</a> ..Default::default()
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub fn </span>new_many&lt;F&gt;(filters: F, properties: <span class="prelude-ty">Option</span>&lt;SubscribeProperties&gt;) -&gt; <span class="self">Self
<a href=#22 id=22 data-nosnippet>22</a> </span><span class="kw">where
<a href=#23 id=23 data-nosnippet>23</a> </span>F: IntoIterator&lt;Item = Filter&gt;,
<a href=#24 id=24 data-nosnippet>24</a> {
<a href=#25 id=25 data-nosnippet>25</a> <span class="self">Self </span>{
<a href=#26 id=26 data-nosnippet>26</a> filters: filters.into_iter().collect(),
<a href=#27 id=27 data-nosnippet>27</a> properties,
<a href=#28 id=28 data-nosnippet>28</a> ..Default::default()
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a> }
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="self">self</span>.filters.iter().fold(<span class="number">0</span>, |s, t| s + t.len());
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>properties_len = p.len();
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#45 id=45 data-nosnippet>45</a> len += properties_len_len + properties_len;
<a href=#46 id=46 data-nosnippet>46</a> } <span class="kw">else </span>{
<a href=#47 id=47 data-nosnippet>47</a> <span class="comment">// just 1 byte representing 0 len
<a href=#48 id=48 data-nosnippet>48</a> </span>len += <span class="number">1</span>;
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> len
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;Subscribe, Error&gt; {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#56 id=56 data-nosnippet>56</a> bytes.advance(variable_header_index);
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span>properties = SubscribeProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="comment">// variable header size = 2 (packet identifier)
<a href=#62 id=62 data-nosnippet>62</a> </span><span class="kw">let </span>filters = Filter::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#63 id=63 data-nosnippet>63</a>
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">match </span>filters.len() {
<a href=#65 id=65 data-nosnippet>65</a> <span class="number">0 </span>=&gt; <span class="prelude-val">Err</span>(Error::EmptySubscription),
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Ok</span>(Subscribe {
<a href=#67 id=67 data-nosnippet>67</a> pkid,
<a href=#68 id=68 data-nosnippet>68</a> filters,
<a href=#69 id=69 data-nosnippet>69</a> properties,
<a href=#70 id=70 data-nosnippet>70</a> }),
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#75 id=75 data-nosnippet>75</a> <span class="comment">// write packet type
<a href=#76 id=76 data-nosnippet>76</a> </span>buffer.put_u8(<span class="number">0x82</span>);
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="comment">// write remaining length
<a href=#79 id=79 data-nosnippet>79</a> </span><span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="comment">// write packet id
<a href=#83 id=83 data-nosnippet>83</a> </span>buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#86 id=86 data-nosnippet>86</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#87 id=87 data-nosnippet>87</a> } <span class="kw">else </span>{
<a href=#88 id=88 data-nosnippet>88</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a> <span class="comment">// write filters
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="kw">for </span>f <span class="kw">in </span><span class="self">self</span>.filters.iter() {
<a href=#93 id=93 data-nosnippet>93</a> f.write(buffer);
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>}
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a><span class="doccomment">/// Subscription filter
<a href=#101 id=101 data-nosnippet>101</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq, Default)]
<a href=#102 id=102 data-nosnippet>102</a></span><span class="kw">pub struct </span>Filter {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">pub </span>path: String,
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">pub </span>qos: QoS,
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">pub </span>nolocal: bool,
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">pub </span>preserve_retain: bool,
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub </span>retain_forward_rule: RetainForwardRule,
<a href=#108 id=108 data-nosnippet>108</a>}
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a><span class="kw">impl </span>Filter {
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">pub fn </span>new&lt;T: Into&lt;String&gt;&gt;(topic: T, qos: QoS) -&gt; <span class="self">Self </span>{
<a href=#112 id=112 data-nosnippet>112</a> <span class="self">Self </span>{
<a href=#113 id=113 data-nosnippet>113</a> path: topic.into(),
<a href=#114 id=114 data-nosnippet>114</a> qos,
<a href=#115 id=115 data-nosnippet>115</a> ..Default::default()
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#120 id=120 data-nosnippet>120</a> <span class="comment">// filter len + filter + options
<a href=#121 id=121 data-nosnippet>121</a> </span><span class="number">2 </span>+ <span class="self">self</span>.path.len() + <span class="number">1
<a href=#122 id=122 data-nosnippet>122</a> </span>}
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;Filter&gt;, Error&gt; {
<a href=#125 id=125 data-nosnippet>125</a> <span class="comment">// variable header size = 2 (packet identifier)
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">let </span><span class="kw-2">mut </span>filters = Vec::new();
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">let </span>path = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">let </span>options = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">let </span>requested_qos = options &amp; <span class="number">0b0000_0011</span>;
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span>nolocal = options &gt;&gt; <span class="number">2 </span>&amp; <span class="number">0b0000_0001</span>;
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">let </span>nolocal = nolocal != <span class="number">0</span>;
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">let </span>preserve_retain = options &gt;&gt; <span class="number">3 </span>&amp; <span class="number">0b0000_0001</span>;
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>preserve_retain = preserve_retain != <span class="number">0</span>;
<a href=#138 id=138 data-nosnippet>138</a>
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">let </span>retain_forward_rule = (options &gt;&gt; <span class="number">4</span>) &amp; <span class="number">0b0000_0011</span>;
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>retain_forward_rule = <span class="kw">match </span>retain_forward_rule {
<a href=#141 id=141 data-nosnippet>141</a> <span class="number">0 </span>=&gt; RetainForwardRule::OnEverySubscribe,
<a href=#142 id=142 data-nosnippet>142</a> <span class="number">1 </span>=&gt; RetainForwardRule::OnNewSubscribe,
<a href=#143 id=143 data-nosnippet>143</a> <span class="number">2 </span>=&gt; RetainForwardRule::Never,
<a href=#144 id=144 data-nosnippet>144</a> r =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidRetainForwardRule(r)),
<a href=#145 id=145 data-nosnippet>145</a> };
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> filters.push(Filter {
<a href=#148 id=148 data-nosnippet>148</a> path,
<a href=#149 id=149 data-nosnippet>149</a> qos: qos(requested_qos).ok_or(Error::InvalidQoS(requested_qos))<span class="question-mark">?</span>,
<a href=#150 id=150 data-nosnippet>150</a> nolocal,
<a href=#151 id=151 data-nosnippet>151</a> preserve_retain,
<a href=#152 id=152 data-nosnippet>152</a> retain_forward_rule,
<a href=#153 id=153 data-nosnippet>153</a> });
<a href=#154 id=154 data-nosnippet>154</a> }
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="prelude-val">Ok</span>(filters)
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) {
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">let </span><span class="kw-2">mut </span>options = <span class="number">0</span>;
<a href=#161 id=161 data-nosnippet>161</a> options |= <span class="self">self</span>.qos <span class="kw">as </span>u8;
<a href=#162 id=162 data-nosnippet>162</a>
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">if </span><span class="self">self</span>.nolocal {
<a href=#164 id=164 data-nosnippet>164</a> options |= <span class="number">0b0000_0100</span>;
<a href=#165 id=165 data-nosnippet>165</a> }
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">if </span><span class="self">self</span>.preserve_retain {
<a href=#168 id=168 data-nosnippet>168</a> options |= <span class="number">0b0000_1000</span>;
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a>
<a href=#171 id=171 data-nosnippet>171</a> options |= <span class="kw">match </span><span class="self">self</span>.retain_forward_rule {
<a href=#172 id=172 data-nosnippet>172</a> RetainForwardRule::OnEverySubscribe =&gt; <span class="number">0b0000_0000</span>,
<a href=#173 id=173 data-nosnippet>173</a> RetainForwardRule::OnNewSubscribe =&gt; <span class="number">0b0001_0000</span>,
<a href=#174 id=174 data-nosnippet>174</a> RetainForwardRule::Never =&gt; <span class="number">0b0010_0000</span>,
<a href=#175 id=175 data-nosnippet>175</a> };
<a href=#176 id=176 data-nosnippet>176</a>
<a href=#177 id=177 data-nosnippet>177</a> write_mqtt_string(buffer, <span class="self">self</span>.path.as_str());
<a href=#178 id=178 data-nosnippet>178</a> buffer.put_u8(options);
<a href=#179 id=179 data-nosnippet>179</a> }
<a href=#180 id=180 data-nosnippet>180</a>}
<a href=#181 id=181 data-nosnippet>181</a>
<a href=#182 id=182 data-nosnippet>182</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#183 id=183 data-nosnippet>183</a></span><span class="kw">pub enum </span>RetainForwardRule {
<a href=#184 id=184 data-nosnippet>184</a> OnEverySubscribe,
<a href=#185 id=185 data-nosnippet>185</a> OnNewSubscribe,
<a href=#186 id=186 data-nosnippet>186</a> Never,
<a href=#187 id=187 data-nosnippet>187</a>}
<a href=#188 id=188 data-nosnippet>188</a>
<a href=#189 id=189 data-nosnippet>189</a><span class="kw">impl </span>Default <span class="kw">for </span>RetainForwardRule {
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#191 id=191 data-nosnippet>191</a> <span class="self">Self</span>::OnEverySubscribe
<a href=#192 id=192 data-nosnippet>192</a> }
<a href=#193 id=193 data-nosnippet>193</a>}
<a href=#194 id=194 data-nosnippet>194</a>
<a href=#195 id=195 data-nosnippet>195</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#196 id=196 data-nosnippet>196</a></span><span class="kw">pub struct </span>SubscribeProperties {
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw">pub </span>id: <span class="prelude-ty">Option</span>&lt;usize&gt;,
<a href=#198 id=198 data-nosnippet>198</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#199 id=199 data-nosnippet>199</a>}
<a href=#200 id=200 data-nosnippet>200</a>
<a href=#201 id=201 data-nosnippet>201</a><span class="kw">impl </span>SubscribeProperties {
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#204 id=204 data-nosnippet>204</a>
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(id) = <span class="kw-2">&amp;</span><span class="self">self</span>.id {
<a href=#206 id=206 data-nosnippet>206</a> len += <span class="number">1 </span>+ len_len(<span class="kw-2">*</span>id);
<a href=#207 id=207 data-nosnippet>207</a> }
<a href=#208 id=208 data-nosnippet>208</a>
<a href=#209 id=209 data-nosnippet>209</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#210 id=210 data-nosnippet>210</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#211 id=211 data-nosnippet>211</a> }
<a href=#212 id=212 data-nosnippet>212</a>
<a href=#213 id=213 data-nosnippet>213</a> len
<a href=#214 id=214 data-nosnippet>214</a> }
<a href=#215 id=215 data-nosnippet>215</a>
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;SubscribeProperties&gt;, Error&gt; {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span><span class="kw-2">mut </span>id = <span class="prelude-val">None</span>;
<a href=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#219 id=219 data-nosnippet>219</a>
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#221 id=221 data-nosnippet>221</a> bytes.advance(properties_len_len);
<a href=#222 id=222 data-nosnippet>222</a>
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#225 id=225 data-nosnippet>225</a> }
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#228 id=228 data-nosnippet>228</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#229 id=229 data-nosnippet>229</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#231 id=231 data-nosnippet>231</a> cursor += <span class="number">1</span>;
<a href=#232 id=232 data-nosnippet>232</a>
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#234 id=234 data-nosnippet>234</a> PropertyType::SubscriptionIdentifier =&gt; {
<a href=#235 id=235 data-nosnippet>235</a> <span class="kw">let </span>(id_len, sub_id) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#236 id=236 data-nosnippet>236</a> <span class="comment">// TODO: Validate 1 +. Tests are working either way
<a href=#237 id=237 data-nosnippet>237</a> </span>cursor += <span class="number">1 </span>+ id_len;
<a href=#238 id=238 data-nosnippet>238</a> bytes.advance(id_len);
<a href=#239 id=239 data-nosnippet>239</a> id = <span class="prelude-val">Some</span>(sub_id)
<a href=#240 id=240 data-nosnippet>240</a> }
<a href=#241 id=241 data-nosnippet>241</a> PropertyType::UserProperty =&gt; {
<a href=#242 id=242 data-nosnippet>242</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#243 id=243 data-nosnippet>243</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#244 id=244 data-nosnippet>244</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#245 id=245 data-nosnippet>245</a> user_properties.push((key, value));
<a href=#246 id=246 data-nosnippet>246</a> }
<a href=#247 id=247 data-nosnippet>247</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#248 id=248 data-nosnippet>248</a> }
<a href=#249 id=249 data-nosnippet>249</a> }
<a href=#250 id=250 data-nosnippet>250</a>
<a href=#251 id=251 data-nosnippet>251</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(SubscribeProperties {
<a href=#252 id=252 data-nosnippet>252</a> id,
<a href=#253 id=253 data-nosnippet>253</a> user_properties,
<a href=#254 id=254 data-nosnippet>254</a> }))
<a href=#255 id=255 data-nosnippet>255</a> }
<a href=#256 id=256 data-nosnippet>256</a>
<a href=#257 id=257 data-nosnippet>257</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#258 id=258 data-nosnippet>258</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#259 id=259 data-nosnippet>259</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#260 id=260 data-nosnippet>260</a>
<a href=#261 id=261 data-nosnippet>261</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(id) = <span class="kw-2">&amp;</span><span class="self">self</span>.id {
<a href=#262 id=262 data-nosnippet>262</a> buffer.put_u8(PropertyType::SubscriptionIdentifier <span class="kw">as </span>u8);
<a href=#263 id=263 data-nosnippet>263</a> write_remaining_length(buffer, <span class="kw-2">*</span>id)<span class="question-mark">?</span>;
<a href=#264 id=264 data-nosnippet>264</a> }
<a href=#265 id=265 data-nosnippet>265</a>
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#267 id=267 data-nosnippet>267</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#268 id=268 data-nosnippet>268</a> write_mqtt_string(buffer, key);
<a href=#269 id=269 data-nosnippet>269</a> write_mqtt_string(buffer, value);
<a href=#270 id=270 data-nosnippet>270</a> }
<a href=#271 id=271 data-nosnippet>271</a>
<a href=#272 id=272 data-nosnippet>272</a> <span class="prelude-val">Ok</span>(())
<a href=#273 id=273 data-nosnippet>273</a> }
<a href=#274 id=274 data-nosnippet>274</a>}
<a href=#275 id=275 data-nosnippet>275</a>
<a href=#276 id=276 data-nosnippet>276</a><span class="attr">#[cfg(test)]
<a href=#277 id=277 data-nosnippet>277</a></span><span class="kw">mod </span>test {
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#279 id=279 data-nosnippet>279</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#280 id=280 data-nosnippet>280</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="attr">#[test]
<a href=#284 id=284 data-nosnippet>284</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#285 id=285 data-nosnippet>285</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#286 id=286 data-nosnippet>286</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#287 id=287 data-nosnippet>287</a> // remaining_length field in the packet be 2 bytes long.
<a href=#288 id=288 data-nosnippet>288</a> </span><span class="kw">let </span>subscribe_props = SubscribeProperties {
<a href=#289 id=289 data-nosnippet>289</a> id: <span class="prelude-val">None</span>,
<a href=#290 id=290 data-nosnippet>290</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#291 id=291 data-nosnippet>291</a> };
<a href=#292 id=292 data-nosnippet>292</a>
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">let </span>subscribe_pkt = Subscribe::new(
<a href=#294 id=294 data-nosnippet>294</a> Filter::new(<span class="string">"hello/world"</span>, QoS::AtMostOnce),
<a href=#295 id=295 data-nosnippet>295</a> <span class="prelude-val">Some</span>(subscribe_props),
<a href=#296 id=296 data-nosnippet>296</a> );
<a href=#297 id=297 data-nosnippet>297</a>
<a href=#298 id=298 data-nosnippet>298</a> <span class="kw">let </span>size_from_size = subscribe_pkt.size();
<a href=#299 id=299 data-nosnippet>299</a> <span class="kw">let </span>size_from_write = subscribe_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#300 id=300 data-nosnippet>300</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#301 id=301 data-nosnippet>301</a>
<a href=#302 id=302 data-nosnippet>302</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#303 id=303 data-nosnippet>303</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#304 id=304 data-nosnippet>304</a> }
<a href=#305 id=305 data-nosnippet>305</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,228 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/unsuback.rs`."><title>unsuback.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>unsuback.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Acknowledgement to unsubscribe
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>UnsubAck {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw">pub </span>pkid: u16,
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>reasons: Vec&lt;UnsubAckReason&gt;,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;UnsubAckProperties&gt;,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>UnsubAck {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="self">self</span>.reasons.len();
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>properties_len = p.len();
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#19 id=19 data-nosnippet>19</a> len += properties_len_len + properties_len;
<a href=#20 id=20 data-nosnippet>20</a> } <span class="kw">else </span>{
<a href=#21 id=21 data-nosnippet>21</a> <span class="comment">// just 1 byte representing 0 len
<a href=#22 id=22 data-nosnippet>22</a> </span>len += <span class="number">1</span>;
<a href=#23 id=23 data-nosnippet>23</a> }
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> len
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;UnsubAck, Error&gt; {
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#37 id=37 data-nosnippet>37</a> bytes.advance(variable_header_index);
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>properties = UnsubAckProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if </span>!bytes.has_remaining() {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span><span class="kw-2">mut </span>reasons = Vec::new();
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>r = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#49 id=49 data-nosnippet>49</a> reasons.push(reason(r)<span class="question-mark">?</span>);
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>unsuback = UnsubAck {
<a href=#53 id=53 data-nosnippet>53</a> pkid,
<a href=#54 id=54 data-nosnippet>54</a> reasons,
<a href=#55 id=55 data-nosnippet>55</a> properties,
<a href=#56 id=56 data-nosnippet>56</a> };
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">Ok</span>(unsuback)
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#62 id=62 data-nosnippet>62</a> buffer.put_u8(<span class="number">0xB0</span>);
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#69 id=69 data-nosnippet>69</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#70 id=70 data-nosnippet>70</a> } <span class="kw">else </span>{
<a href=#71 id=71 data-nosnippet>71</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>p: Vec&lt;u8&gt; = <span class="self">self</span>.reasons.iter().map(|<span class="kw-2">&amp;</span>c| code(c)).collect();
<a href=#75 id=75 data-nosnippet>75</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span>p);
<a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>}
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#81 id=81 data-nosnippet>81</a>#[repr(u8)]
<a href=#82 id=82 data-nosnippet>82</a></span><span class="kw">pub enum </span>UnsubAckReason {
<a href=#83 id=83 data-nosnippet>83</a> Success,
<a href=#84 id=84 data-nosnippet>84</a> NoSubscriptionExisted,
<a href=#85 id=85 data-nosnippet>85</a> UnspecifiedError,
<a href=#86 id=86 data-nosnippet>86</a> ImplementationSpecificError,
<a href=#87 id=87 data-nosnippet>87</a> NotAuthorized,
<a href=#88 id=88 data-nosnippet>88</a> TopicFilterInvalid,
<a href=#89 id=89 data-nosnippet>89</a> PacketIdentifierInUse,
<a href=#90 id=90 data-nosnippet>90</a>}
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#93 id=93 data-nosnippet>93</a></span><span class="kw">pub struct </span>UnsubAckProperties {
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">pub </span>reason_string: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#96 id=96 data-nosnippet>96</a>}
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a><span class="kw">impl </span>UnsubAckProperties {
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#103 id=103 data-nosnippet>103</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ reason.len();
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#107 id=107 data-nosnippet>107</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> len
<a href=#111 id=111 data-nosnippet>111</a> }
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;UnsubAckProperties&gt;, Error&gt; {
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">let </span><span class="kw-2">mut </span>reason_string = <span class="prelude-val">None</span>;
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#118 id=118 data-nosnippet>118</a> bytes.advance(properties_len_len);
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#121 id=121 data-nosnippet>121</a> }
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#124 id=124 data-nosnippet>124</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#127 id=127 data-nosnippet>127</a> cursor += <span class="number">1</span>;
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#130 id=130 data-nosnippet>130</a> PropertyType::ReasonString =&gt; {
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">let </span>reason = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#132 id=132 data-nosnippet>132</a> cursor += <span class="number">2 </span>+ reason.len();
<a href=#133 id=133 data-nosnippet>133</a> reason_string = <span class="prelude-val">Some</span>(reason);
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a> PropertyType::UserProperty =&gt; {
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#138 id=138 data-nosnippet>138</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#139 id=139 data-nosnippet>139</a> user_properties.push((key, value));
<a href=#140 id=140 data-nosnippet>140</a> }
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#142 id=142 data-nosnippet>142</a> }
<a href=#143 id=143 data-nosnippet>143</a> }
<a href=#144 id=144 data-nosnippet>144</a>
<a href=#145 id=145 data-nosnippet>145</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(UnsubAckProperties {
<a href=#146 id=146 data-nosnippet>146</a> reason_string,
<a href=#147 id=147 data-nosnippet>147</a> user_properties,
<a href=#148 id=148 data-nosnippet>148</a> }))
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#153 id=153 data-nosnippet>153</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(reason) = <span class="kw-2">&amp;</span><span class="self">self</span>.reason_string {
<a href=#156 id=156 data-nosnippet>156</a> buffer.put_u8(PropertyType::ReasonString <span class="kw">as </span>u8);
<a href=#157 id=157 data-nosnippet>157</a> write_mqtt_string(buffer, reason);
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#161 id=161 data-nosnippet>161</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#162 id=162 data-nosnippet>162</a> write_mqtt_string(buffer, key);
<a href=#163 id=163 data-nosnippet>163</a> write_mqtt_string(buffer, value);
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> <span class="prelude-val">Ok</span>(())
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>}
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a><span class="doccomment">/// Connection return code type
<a href=#171 id=171 data-nosnippet>171</a></span><span class="kw">fn </span>reason(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;UnsubAckReason, Error&gt; {
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">let </span>code = <span class="kw">match </span>num {
<a href=#173 id=173 data-nosnippet>173</a> <span class="number">0x00 </span>=&gt; UnsubAckReason::Success,
<a href=#174 id=174 data-nosnippet>174</a> <span class="number">0x11 </span>=&gt; UnsubAckReason::NoSubscriptionExisted,
<a href=#175 id=175 data-nosnippet>175</a> <span class="number">0x80 </span>=&gt; UnsubAckReason::UnspecifiedError,
<a href=#176 id=176 data-nosnippet>176</a> <span class="number">0x83 </span>=&gt; UnsubAckReason::ImplementationSpecificError,
<a href=#177 id=177 data-nosnippet>177</a> <span class="number">0x87 </span>=&gt; UnsubAckReason::NotAuthorized,
<a href=#178 id=178 data-nosnippet>178</a> <span class="number">0x8F </span>=&gt; UnsubAckReason::TopicFilterInvalid,
<a href=#179 id=179 data-nosnippet>179</a> <span class="number">0x91 </span>=&gt; UnsubAckReason::PacketIdentifierInUse,
<a href=#180 id=180 data-nosnippet>180</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidSubscribeReasonCode(num)),
<a href=#181 id=181 data-nosnippet>181</a> };
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="prelude-val">Ok</span>(code)
<a href=#184 id=184 data-nosnippet>184</a>}
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a><span class="kw">fn </span>code(reason: UnsubAckReason) -&gt; u8 {
<a href=#187 id=187 data-nosnippet>187</a> <span class="kw">match </span>reason {
<a href=#188 id=188 data-nosnippet>188</a> UnsubAckReason::Success =&gt; <span class="number">0x00</span>,
<a href=#189 id=189 data-nosnippet>189</a> UnsubAckReason::NoSubscriptionExisted =&gt; <span class="number">0x11</span>,
<a href=#190 id=190 data-nosnippet>190</a> UnsubAckReason::UnspecifiedError =&gt; <span class="number">0x80</span>,
<a href=#191 id=191 data-nosnippet>191</a> UnsubAckReason::ImplementationSpecificError =&gt; <span class="number">0x83</span>,
<a href=#192 id=192 data-nosnippet>192</a> UnsubAckReason::NotAuthorized =&gt; <span class="number">0x87</span>,
<a href=#193 id=193 data-nosnippet>193</a> UnsubAckReason::TopicFilterInvalid =&gt; <span class="number">0x8F</span>,
<a href=#194 id=194 data-nosnippet>194</a> UnsubAckReason::PacketIdentifierInUse =&gt; <span class="number">0x91</span>,
<a href=#195 id=195 data-nosnippet>195</a> }
<a href=#196 id=196 data-nosnippet>196</a>}
<a href=#197 id=197 data-nosnippet>197</a>
<a href=#198 id=198 data-nosnippet>198</a><span class="attr">#[cfg(test)]
<a href=#199 id=199 data-nosnippet>199</a></span><span class="kw">mod </span>test {
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#204 id=204 data-nosnippet>204</a>
<a href=#205 id=205 data-nosnippet>205</a> <span class="attr">#[test]
<a href=#206 id=206 data-nosnippet>206</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#208 id=208 data-nosnippet>208</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#209 id=209 data-nosnippet>209</a> // remaining_length field in the packet be 2 bytes long.
<a href=#210 id=210 data-nosnippet>210</a> </span><span class="kw">let </span>unsuback_props = UnsubAckProperties {
<a href=#211 id=211 data-nosnippet>211</a> reason_string: <span class="prelude-val">None</span>,
<a href=#212 id=212 data-nosnippet>212</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#213 id=213 data-nosnippet>213</a> };
<a href=#214 id=214 data-nosnippet>214</a>
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span>unsuback_pkt = UnsubAck {
<a href=#216 id=216 data-nosnippet>216</a> pkid: <span class="number">1</span>,
<a href=#217 id=217 data-nosnippet>217</a> reasons: <span class="macro">vec!</span>[UnsubAckReason::Success],
<a href=#218 id=218 data-nosnippet>218</a> properties: <span class="prelude-val">Some</span>(unsuback_props),
<a href=#219 id=219 data-nosnippet>219</a> };
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">let </span>size_from_size = unsuback_pkt.size();
<a href=#222 id=222 data-nosnippet>222</a> <span class="kw">let </span>size_from_write = unsuback_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#226 id=226 data-nosnippet>226</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#227 id=227 data-nosnippet>227</a> }
<a href=#228 id=228 data-nosnippet>228</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,176 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/gilles/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rumqttc-0.24.0/src/v5/mqttbytes/v5/unsubscribe.rs`."><title>unsubscribe.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="rumqttc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rumqttc/v5/mqttbytes/v5/</div>unsubscribe.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>bytes::{Buf, Bytes};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Unsubscribe packet
<a href=#5 id=5 data-nosnippet>5</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, Default)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub struct </span>Unsubscribe {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw">pub </span>pkid: u16,
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>filters: Vec&lt;String&gt;,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>properties: <span class="prelude-ty">Option</span>&lt;UnsubscribeProperties&gt;,
<a href=#10 id=10 data-nosnippet>10</a>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">impl </span>Unsubscribe {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;&gt;(filter: S, properties: <span class="prelude-ty">Option</span>&lt;UnsubscribeProperties&gt;) -&gt; <span class="self">Self </span>{
<a href=#14 id=14 data-nosnippet>14</a> <span class="self">Self </span>{
<a href=#15 id=15 data-nosnippet>15</a> filters: <span class="macro">vec!</span>[filter.into()],
<a href=#16 id=16 data-nosnippet>16</a> properties,
<a href=#17 id=17 data-nosnippet>17</a> ..Default::default()
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> <span class="number">1 </span>+ remaining_len_size + len
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#29 id=29 data-nosnippet>29</a> <span class="comment">// Packet id + length of filters (unlike subscribe, this just a string.
<a href=#30 id=30 data-nosnippet>30</a> // Hence 2 is prefixed for len per filter)
<a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">2 </span>+ <span class="self">self</span>.filters.iter().fold(<span class="number">0</span>, |s, t| <span class="number">2 </span>+ s + t.len());
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>properties_len = p.len();
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span>properties_len_len = len_len(properties_len);
<a href=#36 id=36 data-nosnippet>36</a> len += properties_len_len + properties_len;
<a href=#37 id=37 data-nosnippet>37</a> } <span class="kw">else </span>{
<a href=#38 id=38 data-nosnippet>38</a> <span class="comment">// just 1 byte representing 0 len
<a href=#39 id=39 data-nosnippet>39</a> </span>len += <span class="number">1</span>;
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> len
<a href=#43 id=43 data-nosnippet>43</a> }
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">pub fn </span>read(fixed_header: FixedHeader, <span class="kw-2">mut </span>bytes: Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;Unsubscribe, Error&gt; {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#47 id=47 data-nosnippet>47</a> bytes.advance(variable_header_index);
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>properties = UnsubscribeProperties::read(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span><span class="kw-2">mut </span>filters = Vec::with_capacity(<span class="number">1</span>);
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">let </span>filter = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#55 id=55 data-nosnippet>55</a> filters.push(filter);
<a href=#56 id=56 data-nosnippet>56</a> }
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>unsubscribe = Unsubscribe {
<a href=#59 id=59 data-nosnippet>59</a> pkid,
<a href=#60 id=60 data-nosnippet>60</a> filters,
<a href=#61 id=61 data-nosnippet>61</a> properties,
<a href=#62 id=62 data-nosnippet>62</a> };
<a href=#63 id=63 data-nosnippet>63</a> <span class="prelude-val">Ok</span>(unsubscribe)
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#67 id=67 data-nosnippet>67</a> buffer.put_u8(<span class="number">0xA2</span>);
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="comment">// write remaining length
<a href=#70 id=70 data-nosnippet>70</a> </span><span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="comment">// write packet id
<a href=#74 id=74 data-nosnippet>74</a> </span>buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(p) = <span class="kw-2">&amp;</span><span class="self">self</span>.properties {
<a href=#77 id=77 data-nosnippet>77</a> p.write(buffer)<span class="question-mark">?</span>;
<a href=#78 id=78 data-nosnippet>78</a> } <span class="kw">else </span>{
<a href=#79 id=79 data-nosnippet>79</a> write_remaining_length(buffer, <span class="number">0</span>)<span class="question-mark">?</span>;
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="comment">// write filters
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">for </span>filter <span class="kw">in </span><span class="self">self</span>.filters.iter() {
<a href=#84 id=84 data-nosnippet>84</a> write_mqtt_string(buffer, filter);
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a>
<a href=#87 id=87 data-nosnippet>87</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a>}
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#92 id=92 data-nosnippet>92</a></span><span class="kw">pub struct </span>UnsubscribeProperties {
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">pub </span>user_properties: Vec&lt;(String, String)&gt;,
<a href=#94 id=94 data-nosnippet>94</a>}
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a><span class="kw">impl </span>UnsubscribeProperties {
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#101 id=101 data-nosnippet>101</a> len += <span class="number">1 </span>+ <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> len
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub fn </span>read(bytes: <span class="kw-2">&amp;mut </span>Bytes) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;UnsubscribeProperties&gt;, Error&gt; {
<a href=#108 id=108 data-nosnippet>108</a> <span class="kw">let </span><span class="kw-2">mut </span>user_properties = Vec::new();
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>(properties_len_len, properties_len) = length(bytes.iter())<span class="question-mark">?</span>;
<a href=#111 id=111 data-nosnippet>111</a> bytes.advance(properties_len_len);
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">if </span>properties_len == <span class="number">0 </span>{
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
<a href=#115 id=115 data-nosnippet>115</a> }
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="number">0</span>;
<a href=#118 id=118 data-nosnippet>118</a> <span class="comment">// read until cursor reaches property length. properties_len = 0 will skip this loop
<a href=#119 id=119 data-nosnippet>119</a> </span><span class="kw">while </span>cursor &lt; properties_len {
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span>prop = read_u8(bytes)<span class="question-mark">?</span>;
<a href=#121 id=121 data-nosnippet>121</a> cursor += <span class="number">1</span>;
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">match </span>property(prop)<span class="question-mark">? </span>{
<a href=#124 id=124 data-nosnippet>124</a> PropertyType::UserProperty =&gt; {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span>key = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>value = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#127 id=127 data-nosnippet>127</a> cursor += <span class="number">2 </span>+ key.len() + <span class="number">2 </span>+ value.len();
<a href=#128 id=128 data-nosnippet>128</a> user_properties.push((key, value));
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidPropertyType(prop)),
<a href=#131 id=131 data-nosnippet>131</a> }
<a href=#132 id=132 data-nosnippet>132</a> }
<a href=#133 id=133 data-nosnippet>133</a>
<a href=#134 id=134 data-nosnippet>134</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(UnsubscribeProperties { user_properties }))
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#139 id=139 data-nosnippet>139</a> write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">for </span>(key, value) <span class="kw">in </span><span class="self">self</span>.user_properties.iter() {
<a href=#142 id=142 data-nosnippet>142</a> buffer.put_u8(PropertyType::UserProperty <span class="kw">as </span>u8);
<a href=#143 id=143 data-nosnippet>143</a> write_mqtt_string(buffer, key);
<a href=#144 id=144 data-nosnippet>144</a> write_mqtt_string(buffer, value);
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="prelude-val">Ok</span>(())
<a href=#148 id=148 data-nosnippet>148</a> }
<a href=#149 id=149 data-nosnippet>149</a>}
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a><span class="attr">#[cfg(test)]
<a href=#152 id=152 data-nosnippet>152</a></span><span class="kw">mod </span>test {
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::test::{USER_PROP_KEY, USER_PROP_VAL};
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#157 id=157 data-nosnippet>157</a>
<a href=#158 id=158 data-nosnippet>158</a> <span class="attr">#[test]
<a href=#159 id=159 data-nosnippet>159</a> </span><span class="kw">fn </span>length_calculation() {
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">let </span><span class="kw-2">mut </span>dummy_bytes = BytesMut::new();
<a href=#161 id=161 data-nosnippet>161</a> <span class="comment">// Use user_properties to pad the size to exceed ~128 bytes to make the
<a href=#162 id=162 data-nosnippet>162</a> // remaining_length field in the packet be 2 bytes long.
<a href=#163 id=163 data-nosnippet>163</a> </span><span class="kw">let </span>unsubscribe_props = UnsubscribeProperties {
<a href=#164 id=164 data-nosnippet>164</a> user_properties: <span class="macro">vec!</span>[(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
<a href=#165 id=165 data-nosnippet>165</a> };
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">let </span>unsubscribe_pkt = Unsubscribe::new(<span class="string">"hello/world"</span>, <span class="prelude-val">Some</span>(unsubscribe_props));
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">let </span>size_from_size = unsubscribe_pkt.size();
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span>size_from_write = unsubscribe_pkt.write(<span class="kw-2">&amp;mut </span>dummy_bytes).unwrap();
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">let </span>size_from_bytes = dummy_bytes.len();
<a href=#172 id=172 data-nosnippet>172</a>
<a href=#173 id=173 data-nosnippet>173</a> <span class="macro">assert_eq!</span>(size_from_write, size_from_bytes);
<a href=#174 id=174 data-nosnippet>174</a> <span class="macro">assert_eq!</span>(size_from_size, size_from_bytes);
<a href=#175 id=175 data-nosnippet>175</a> }
<a href=#176 id=176 data-nosnippet>176</a>}</code></pre></div></section></main></body></html>