Gilles SoulierandClaude Sonnet 4.5
c5381b7112
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>
495 lines
50 KiB
HTML
495 lines
50 KiB
HTML
<!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><LastWill>, <span class="prelude-ty">Option</span><Login>),
|
|
<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">&mut </span>BytesMut, max_size: <span class="prelude-ty">Option</span><usize>) -> <span class="prelude-ty">Result</span><Packet, Error> {
|
|
<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 => <span class="prelude-val">Ok</span>(Packet::PingReq(PingReq)),
|
|
<a href=#67 id=67 data-nosnippet>67</a> PacketType::PingResp => <span class="prelude-val">Ok</span>(Packet::PingResp(PingResp)),
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">_ </span>=> <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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => {
|
|
<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 => Packet::PingReq(PingReq),
|
|
<a href=#119 id=119 data-nosnippet>119</a> PacketType::PingResp => Packet::PingResp(PingResp),
|
|
<a href=#120 id=120 data-nosnippet>120</a> PacketType::Disconnect => {
|
|
<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">&</span><span class="self">self</span>, write: <span class="kw-2">&mut </span>BytesMut) -> <span class="prelude-ty">Result</span><usize, Error> {
|
|
<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) => publish.write(write),
|
|
<a href=#132 id=132 data-nosnippet>132</a> <span class="self">Self</span>::Subscribe(subscription) => subscription.write(write),
|
|
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">Self</span>::Unsubscribe(unsubscribe) => unsubscribe.write(write),
|
|
<a href=#134 id=134 data-nosnippet>134</a> <span class="self">Self</span>::ConnAck(ack) => ack.write(write),
|
|
<a href=#135 id=135 data-nosnippet>135</a> <span class="self">Self</span>::PubAck(ack) => ack.write(write),
|
|
<a href=#136 id=136 data-nosnippet>136</a> <span class="self">Self</span>::SubAck(ack) => ack.write(write),
|
|
<a href=#137 id=137 data-nosnippet>137</a> <span class="self">Self</span>::UnsubAck(unsuback) => unsuback.write(write),
|
|
<a href=#138 id=138 data-nosnippet>138</a> <span class="self">Self</span>::PubRec(pubrec) => pubrec.write(write),
|
|
<a href=#139 id=139 data-nosnippet>139</a> <span class="self">Self</span>::PubRel(pubrel) => pubrel.write(write),
|
|
<a href=#140 id=140 data-nosnippet>140</a> <span class="self">Self</span>::PubComp(pubcomp) => pubcomp.write(write),
|
|
<a href=#141 id=141 data-nosnippet>141</a> <span class="self">Self</span>::Connect(connect, will, login) => connect.write(will, login, write),
|
|
<a href=#142 id=142 data-nosnippet>142</a> <span class="self">Self</span>::PingReq(<span class="kw">_</span>) => PingReq::write(write),
|
|
<a href=#143 id=143 data-nosnippet>143</a> <span class="self">Self</span>::PingResp(<span class="kw">_</span>) => PingResp::write(write),
|
|
<a href=#144 id=144 data-nosnippet>144</a> <span class="self">Self</span>::Disconnect(disconnect) => 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>/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
|
|
<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) -> 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">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><PacketType, Error> {
|
|
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">let </span>num = <span class="self">self</span>.byte1 >> <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>=> <span class="prelude-val">Ok</span>(PacketType::Connect),
|
|
<a href=#240 id=240 data-nosnippet>240</a> <span class="number">2 </span>=> <span class="prelude-val">Ok</span>(PacketType::ConnAck),
|
|
<a href=#241 id=241 data-nosnippet>241</a> <span class="number">3 </span>=> <span class="prelude-val">Ok</span>(PacketType::Publish),
|
|
<a href=#242 id=242 data-nosnippet>242</a> <span class="number">4 </span>=> <span class="prelude-val">Ok</span>(PacketType::PubAck),
|
|
<a href=#243 id=243 data-nosnippet>243</a> <span class="number">5 </span>=> <span class="prelude-val">Ok</span>(PacketType::PubRec),
|
|
<a href=#244 id=244 data-nosnippet>244</a> <span class="number">6 </span>=> <span class="prelude-val">Ok</span>(PacketType::PubRel),
|
|
<a href=#245 id=245 data-nosnippet>245</a> <span class="number">7 </span>=> <span class="prelude-val">Ok</span>(PacketType::PubComp),
|
|
<a href=#246 id=246 data-nosnippet>246</a> <span class="number">8 </span>=> <span class="prelude-val">Ok</span>(PacketType::Subscribe),
|
|
<a href=#247 id=247 data-nosnippet>247</a> <span class="number">9 </span>=> <span class="prelude-val">Ok</span>(PacketType::SubAck),
|
|
<a href=#248 id=248 data-nosnippet>248</a> <span class="number">10 </span>=> <span class="prelude-val">Ok</span>(PacketType::Unsubscribe),
|
|
<a href=#249 id=249 data-nosnippet>249</a> <span class="number">11 </span>=> <span class="prelude-val">Ok</span>(PacketType::UnsubAck),
|
|
<a href=#250 id=250 data-nosnippet>250</a> <span class="number">12 </span>=> <span class="prelude-val">Ok</span>(PacketType::PingReq),
|
|
<a href=#251 id=251 data-nosnippet>251</a> <span class="number">13 </span>=> <span class="prelude-val">Ok</span>(PacketType::PingResp),
|
|
<a href=#252 id=252 data-nosnippet>252</a> <span class="number">14 </span>=> <span class="prelude-val">Ok</span>(PacketType::Disconnect),
|
|
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">_ </span>=> <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">&</span><span class="self">self</span>) -> 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) -> <span class="prelude-ty">Result</span><PropertyType, Error> {
|
|
<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>=> PropertyType::PayloadFormatIndicator,
|
|
<a href=#267 id=267 data-nosnippet>267</a> <span class="number">2 </span>=> PropertyType::MessageExpiryInterval,
|
|
<a href=#268 id=268 data-nosnippet>268</a> <span class="number">3 </span>=> PropertyType::ContentType,
|
|
<a href=#269 id=269 data-nosnippet>269</a> <span class="number">8 </span>=> PropertyType::ResponseTopic,
|
|
<a href=#270 id=270 data-nosnippet>270</a> <span class="number">9 </span>=> PropertyType::CorrelationData,
|
|
<a href=#271 id=271 data-nosnippet>271</a> <span class="number">11 </span>=> PropertyType::SubscriptionIdentifier,
|
|
<a href=#272 id=272 data-nosnippet>272</a> <span class="number">17 </span>=> PropertyType::SessionExpiryInterval,
|
|
<a href=#273 id=273 data-nosnippet>273</a> <span class="number">18 </span>=> PropertyType::AssignedClientIdentifier,
|
|
<a href=#274 id=274 data-nosnippet>274</a> <span class="number">19 </span>=> PropertyType::ServerKeepAlive,
|
|
<a href=#275 id=275 data-nosnippet>275</a> <span class="number">21 </span>=> PropertyType::AuthenticationMethod,
|
|
<a href=#276 id=276 data-nosnippet>276</a> <span class="number">22 </span>=> PropertyType::AuthenticationData,
|
|
<a href=#277 id=277 data-nosnippet>277</a> <span class="number">23 </span>=> PropertyType::RequestProblemInformation,
|
|
<a href=#278 id=278 data-nosnippet>278</a> <span class="number">24 </span>=> PropertyType::WillDelayInterval,
|
|
<a href=#279 id=279 data-nosnippet>279</a> <span class="number">25 </span>=> PropertyType::RequestResponseInformation,
|
|
<a href=#280 id=280 data-nosnippet>280</a> <span class="number">26 </span>=> PropertyType::ResponseInformation,
|
|
<a href=#281 id=281 data-nosnippet>281</a> <span class="number">28 </span>=> PropertyType::ServerReference,
|
|
<a href=#282 id=282 data-nosnippet>282</a> <span class="number">31 </span>=> PropertyType::ReasonString,
|
|
<a href=#283 id=283 data-nosnippet>283</a> <span class="number">33 </span>=> PropertyType::ReceiveMaximum,
|
|
<a href=#284 id=284 data-nosnippet>284</a> <span class="number">34 </span>=> PropertyType::TopicAliasMaximum,
|
|
<a href=#285 id=285 data-nosnippet>285</a> <span class="number">35 </span>=> PropertyType::TopicAlias,
|
|
<a href=#286 id=286 data-nosnippet>286</a> <span class="number">36 </span>=> PropertyType::MaximumQos,
|
|
<a href=#287 id=287 data-nosnippet>287</a> <span class="number">37 </span>=> PropertyType::RetainAvailable,
|
|
<a href=#288 id=288 data-nosnippet>288</a> <span class="number">38 </span>=> PropertyType::UserProperty,
|
|
<a href=#289 id=289 data-nosnippet>289</a> <span class="number">39 </span>=> PropertyType::MaximumPacketSize,
|
|
<a href=#290 id=290 data-nosnippet>290</a> <span class="number">40 </span>=> PropertyType::WildcardSubscriptionAvailable,
|
|
<a href=#291 id=291 data-nosnippet>291</a> <span class="number">41 </span>=> PropertyType::SubscriptionIdentifierAvailable,
|
|
<a href=#292 id=292 data-nosnippet>292</a> <span class="number">42 </span>=> PropertyType::SharedSubscriptionAvailable,
|
|
<a href=#293 id=293 data-nosnippet>293</a> num => <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<u8>, max_packet_size: <span class="prelude-ty">Option</span><usize>) -> <span class="prelude-ty">Result</span><FixedHeader, Error> {
|
|
<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 > 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 < 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<u8>) -> <span class="prelude-ty">Result</span><FixedHeader, Error> {
|
|
<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 < <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<u8>) -> <span class="prelude-ty">Result</span><(usize, usize), Error> {
|
|
<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 & <span class="number">0x7F</span>) << 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 & <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 > <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">&mut </span>Bytes) -> <span class="prelude-ty">Result</span><Bytes, Error> {
|
|
<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 > 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">&mut </span>Bytes) -> <span class="prelude-ty">Result</span><String, Error> {
|
|
<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) => <span class="prelude-val">Ok</span>(v),
|
|
<a href=#407 id=407 data-nosnippet>407</a> <span class="prelude-val">Err</span>(_e) => <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">&mut </span>BytesMut, bytes: <span class="kw-2">&</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">&mut </span>BytesMut, string: <span class="kw-2">&</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">&mut </span>BytesMut, len: usize) -> <span class="prelude-ty">Result</span><usize, Error> {
|
|
<a href=#424 id=424 data-nosnippet>424</a> <span class="kw">if </span>len > <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 > <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) -> usize {
|
|
<a href=#449 id=449 data-nosnippet>449</a> <span class="kw">if </span>len >= <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 >= <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 >= <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">&mut </span>Bytes) -> <span class="prelude-ty">Result</span><u16, Error> {
|
|
<a href=#466 id=466 data-nosnippet>466</a> <span class="kw">if </span>stream.len() < <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">&mut </span>Bytes) -> <span class="prelude-ty">Result</span><u8, Error> {
|
|
<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">&mut </span>Bytes) -> <span class="prelude-ty">Result</span><u32, Error> {
|
|
<a href=#482 id=482 data-nosnippet>482</a> <span class="kw">if </span>stream.len() < <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">&</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">&</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> |