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,124 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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="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>ConnectReturnCode {
<a href=#8 id=8 data-nosnippet>8</a> Success = <span class="number">0</span>,
<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> BadUserNamePassword,
<a href=#13 id=13 data-nosnippet>13</a> NotAuthorized,
<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="doccomment">/// Acknowledgement to connect packet
<a href=#17 id=17 data-nosnippet>17</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">pub struct </span>ConnAck {
<a href=#19 id=19 data-nosnippet>19</a> <span class="kw">pub </span>session_present: bool,
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub </span>code: ConnectReturnCode,
<a href=#21 id=21 data-nosnippet>21</a>}
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">impl </span>ConnAck {
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub fn </span>new(code: ConnectReturnCode, session_present: bool) -&gt; ConnAck {
<a href=#25 id=25 data-nosnippet>25</a> ConnAck {
<a href=#26 id=26 data-nosnippet>26</a> session_present,
<a href=#27 id=27 data-nosnippet>27</a> code,
<a href=#28 id=28 data-nosnippet>28</a> }
<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> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#32 id=32 data-nosnippet>32</a> <span class="comment">// sesssion present + code
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> </span><span class="number">1 </span>+ <span class="number">1
<a href=#35 id=35 data-nosnippet>35</a> </span>}
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</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=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#39 id=39 data-nosnippet>39</a> bytes.advance(variable_header_index);
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">let </span>flags = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#42 id=42 data-nosnippet>42</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=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>session_present = (flags &amp; <span class="number">0x01</span>) == <span class="number">1</span>;
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>code = connect_return(return_code)<span class="question-mark">?</span>;
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>connack = ConnAck {
<a href=#47 id=47 data-nosnippet>47</a> session_present,
<a href=#48 id=48 data-nosnippet>48</a> code,
<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="prelude-val">Ok</span>(connack)
<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>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=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#56 id=56 data-nosnippet>56</a> buffer.put_u8(<span class="number">0x20</span>);
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#59 id=59 data-nosnippet>59</a> buffer.put_u8(<span class="self">self</span>.session_present <span class="kw">as </span>u8);
<a href=#60 id=60 data-nosnippet>60</a> buffer.put_u8(<span class="self">self</span>.code <span class="kw">as </span>u8);
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + 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>
<a href=#66 id=66 data-nosnippet>66</a><span class="doccomment">/// Connection return code type
<a href=#67 id=67 data-nosnippet>67</a></span><span class="kw">fn </span>connect_return(num: u8) -&gt; <span class="prelude-ty">Result</span>&lt;ConnectReturnCode, Error&gt; {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">match </span>num {
<a href=#69 id=69 data-nosnippet>69</a> <span class="number">0 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::Success),
<a href=#70 id=70 data-nosnippet>70</a> <span class="number">1 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::RefusedProtocolVersion),
<a href=#71 id=71 data-nosnippet>71</a> <span class="number">2 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::BadClientId),
<a href=#72 id=72 data-nosnippet>72</a> <span class="number">3 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::ServiceUnavailable),
<a href=#73 id=73 data-nosnippet>73</a> <span class="number">4 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::BadUserNamePassword),
<a href=#74 id=74 data-nosnippet>74</a> <span class="number">5 </span>=&gt; <span class="prelude-val">Ok</span>(ConnectReturnCode::NotAuthorized),
<a href=#75 id=75 data-nosnippet>75</a> num =&gt; <span class="prelude-val">Err</span>(Error::InvalidConnectReturnCode(num)),
<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="attr">#[cfg(test)]
<a href=#80 id=80 data-nosnippet>80</a></span><span class="kw">mod </span>test {
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="attr">#[test]
<a href=#86 id=86 data-nosnippet>86</a> </span><span class="kw">fn </span>connack_parsing_works() {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = bytes::BytesMut::new();
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span>packetstream = <span class="kw-2">&amp;</span>[
<a href=#89 id=89 data-nosnippet>89</a> <span class="number">0b0010_0000</span>,
<a href=#90 id=90 data-nosnippet>90</a> <span class="number">0x02</span>, <span class="comment">// packet type, flags and remaining len
<a href=#91 id=91 data-nosnippet>91</a> </span><span class="number">0x01</span>,
<a href=#92 id=92 data-nosnippet>92</a> <span class="number">0x00</span>, <span class="comment">// variable header. connack flags, connect return code
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="number">0xDE</span>,
<a href=#94 id=94 data-nosnippet>94</a> <span class="number">0xAD</span>,
<a href=#95 id=95 data-nosnippet>95</a> <span class="number">0xBE</span>,
<a href=#96 id=96 data-nosnippet>96</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#97 id=97 data-nosnippet>97</a> </span>];
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> stream.extend_from_slice(<span class="kw-2">&amp;</span>packetstream[..]);
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">let </span>connack_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span>connack = ConnAck::read(fixed_header, connack_bytes).unwrap();
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> <span class="macro">assert_eq!</span>(
<a href=#105 id=105 data-nosnippet>105</a> connack,
<a href=#106 id=106 data-nosnippet>106</a> ConnAck {
<a href=#107 id=107 data-nosnippet>107</a> session_present: <span class="bool-val">true</span>,
<a href=#108 id=108 data-nosnippet>108</a> code: ConnectReturnCode::Success,
<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> }
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="attr">#[test]
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">fn </span>connack_encoding_works() {
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">let </span>connack = ConnAck {
<a href=#116 id=116 data-nosnippet>116</a> session_present: <span class="bool-val">true</span>,
<a href=#117 id=117 data-nosnippet>117</a> code: ConnectReturnCode::Success,
<a href=#118 id=118 data-nosnippet>118</a> };
<a href=#119 id=119 data-nosnippet>119</a>
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
<a href=#121 id=121 data-nosnippet>121</a> connack.write(<span class="kw-2">&amp;mut </span>buf).unwrap();
<a href=#122 id=122 data-nosnippet>122</a> <span class="macro">assert_eq!</span>(buf, <span class="macro">vec!</span>[<span class="number">0b0010_0000</span>, <span class="number">0x02</span>, <span class="number">0x01</span>, <span class="number">0x00</span>]);
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,409 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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 protocol version
<a href=#8 id=8 data-nosnippet>8</a> </span><span class="kw">pub </span>protocol: Protocol,
<a href=#9 id=9 data-nosnippet>9</a> <span class="doccomment">/// Mqtt keep alive time
<a href=#10 id=10 data-nosnippet>10</a> </span><span class="kw">pub </span>keep_alive: u16,
<a href=#11 id=11 data-nosnippet>11</a> <span class="doccomment">/// Client Id
<a href=#12 id=12 data-nosnippet>12</a> </span><span class="kw">pub </span>client_id: String,
<a href=#13 id=13 data-nosnippet>13</a> <span class="doccomment">/// Clean session. Asks the broker to clear previous state
<a href=#14 id=14 data-nosnippet>14</a> </span><span class="kw">pub </span>clean_session: bool,
<a href=#15 id=15 data-nosnippet>15</a> <span class="doccomment">/// Will that broker needs to publish when the client disconnects
<a href=#16 id=16 data-nosnippet>16</a> </span><span class="kw">pub </span>last_will: <span class="prelude-ty">Option</span>&lt;LastWill&gt;,
<a href=#17 id=17 data-nosnippet>17</a> <span class="doccomment">/// Login credentials
<a href=#18 id=18 data-nosnippet>18</a> </span><span class="kw">pub </span>login: <span class="prelude-ty">Option</span>&lt;Login&gt;,
<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">impl </span>Connect {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;&gt;(id: S) -&gt; Connect {
<a href=#23 id=23 data-nosnippet>23</a> Connect {
<a href=#24 id=24 data-nosnippet>24</a> protocol: Protocol::V4,
<a href=#25 id=25 data-nosnippet>25</a> keep_alive: <span class="number">10</span>,
<a href=#26 id=26 data-nosnippet>26</a> client_id: id.into(),
<a href=#27 id=27 data-nosnippet>27</a> clean_session: <span class="bool-val">true</span>,
<a href=#28 id=28 data-nosnippet>28</a> last_will: <span class="prelude-val">None</span>,
<a href=#29 id=29 data-nosnippet>29</a> login: <span class="prelude-val">None</span>,
<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>set_login&lt;U: Into&lt;String&gt;, P: Into&lt;String&gt;&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, u: U, p: P) -&gt; <span class="kw-2">&amp;mut </span>Connect {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>login = Login {
<a href=#35 id=35 data-nosnippet>35</a> username: u.into(),
<a href=#36 id=36 data-nosnippet>36</a> password: p.into(),
<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="self">self</span>.login = <span class="prelude-val">Some</span>(login);
<a href=#40 id=40 data-nosnippet>40</a> <span class="self">self
<a href=#41 id=41 data-nosnippet>41</a> </span>}
<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="string">"MQTT"</span>.len() <span class="comment">// protocol name
<a href=#45 id=45 data-nosnippet>45</a> </span>+ <span class="number">1 </span><span class="comment">// protocol version
<a href=#46 id=46 data-nosnippet>46</a> </span>+ <span class="number">1 </span><span class="comment">// connect flags
<a href=#47 id=47 data-nosnippet>47</a> </span>+ <span class="number">2</span>; <span class="comment">// keep alive
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a> </span>len += <span class="number">2 </span>+ <span class="self">self</span>.client_id.len();
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="comment">// last will len
<a href=#52 id=52 data-nosnippet>52</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(last_will) = <span class="kw-2">&amp;</span><span class="self">self</span>.last_will {
<a href=#53 id=53 data-nosnippet>53</a> len += last_will.len();
<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="comment">// username and password len
<a href=#57 id=57 data-nosnippet>57</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(login) = <span class="kw-2">&amp;</span><span class="self">self</span>.login {
<a href=#58 id=58 data-nosnippet>58</a> len += login.len();
<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> 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;Connect, 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>
<a href=#68 id=68 data-nosnippet>68</a> <span class="comment">// Variable header
<a href=#69 id=69 data-nosnippet>69</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=#70 id=70 data-nosnippet>70</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=#71 id=71 data-nosnippet>71</a> <span class="kw">if </span>protocol_name != <span class="string">"MQTT" </span>{
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidProtocol);
<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">let </span>protocol = <span class="kw">match </span>protocol_level {
<a href=#76 id=76 data-nosnippet>76</a> <span class="number">4 </span>=&gt; Protocol::V4,
<a href=#77 id=77 data-nosnippet>77</a> <span class="number">5 </span>=&gt; Protocol::V5,
<a href=#78 id=78 data-nosnippet>78</a> num =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(Error::InvalidProtocolLevel(num)),
<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="kw">let </span>connect_flags = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>clean_session = (connect_flags &amp; <span class="number">0b10</span>) != <span class="number">0</span>;
<a href=#83 id=83 data-nosnippet>83</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=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</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=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span>last_will = LastWill::read(connect_flags, <span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#87 id=87 data-nosnippet>87</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=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>connect = Connect {
<a href=#90 id=90 data-nosnippet>90</a> protocol,
<a href=#91 id=91 data-nosnippet>91</a> keep_alive,
<a href=#92 id=92 data-nosnippet>92</a> client_id,
<a href=#93 id=93 data-nosnippet>93</a> clean_session,
<a href=#94 id=94 data-nosnippet>94</a> last_will,
<a href=#95 id=95 data-nosnippet>95</a> login,
<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="prelude-val">Ok</span>(connect)
<a href=#99 id=99 data-nosnippet>99</a> }
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</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=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#103 id=103 data-nosnippet>103</a> buffer.put_u8(<span class="number">0b0001_0000</span>);
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#105 id=105 data-nosnippet>105</a> write_mqtt_string(buffer, <span class="string">"MQTT"</span>);
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">match </span><span class="self">self</span>.protocol {
<a href=#108 id=108 data-nosnippet>108</a> Protocol::V4 =&gt; buffer.put_u8(<span class="number">0x04</span>),
<a href=#109 id=109 data-nosnippet>109</a> Protocol::V5 =&gt; buffer.put_u8(<span class="number">0x05</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="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=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">if </span><span class="self">self</span>.clean_session {
<a href=#116 id=116 data-nosnippet>116</a> connect_flags |= <span class="number">0x02</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.put_u8(connect_flags);
<a href=#120 id=120 data-nosnippet>120</a> buffer.put_u16(<span class="self">self</span>.keep_alive);
<a href=#121 id=121 data-nosnippet>121</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.client_id);
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(last_will) = <span class="kw-2">&amp;</span><span class="self">self</span>.last_will {
<a href=#124 id=124 data-nosnippet>124</a> connect_flags |= last_will.write(buffer)<span class="question-mark">?</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">if let </span><span class="prelude-val">Some</span>(login) = <span class="kw-2">&amp;</span><span class="self">self</span>.login {
<a href=#128 id=128 data-nosnippet>128</a> connect_flags |= login.write(buffer);
<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="comment">// update connect flags
<a href=#132 id=132 data-nosnippet>132</a> </span>buffer[flags_index] = connect_flags;
<a href=#133 id=133 data-nosnippet>133</a> <span class="prelude-val">Ok</span>(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>
<a href=#137 id=137 data-nosnippet>137</a><span class="doccomment">/// LastWill that broker forwards on behalf of the client
<a href=#138 id=138 data-nosnippet>138</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#139 id=139 data-nosnippet>139</a></span><span class="kw">pub struct </span>LastWill {
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">pub </span>topic: String,
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">pub </span>message: Bytes,
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">pub </span>qos: QoS,
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">pub </span>retain: bool,
<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">impl </span>LastWill {
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">pub fn </span>new(
<a href=#148 id=148 data-nosnippet>148</a> topic: <span class="kw">impl </span>Into&lt;String&gt;,
<a href=#149 id=149 data-nosnippet>149</a> payload: <span class="kw">impl </span>Into&lt;Vec&lt;u8&gt;&gt;,
<a href=#150 id=150 data-nosnippet>150</a> qos: QoS,
<a href=#151 id=151 data-nosnippet>151</a> retain: bool,
<a href=#152 id=152 data-nosnippet>152</a> ) -&gt; LastWill {
<a href=#153 id=153 data-nosnippet>153</a> LastWill {
<a href=#154 id=154 data-nosnippet>154</a> topic: topic.into(),
<a href=#155 id=155 data-nosnippet>155</a> message: Bytes::from(payload.into()),
<a href=#156 id=156 data-nosnippet>156</a> qos,
<a href=#157 id=157 data-nosnippet>157</a> retain,
<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>
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#163 id=163 data-nosnippet>163</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=#164 id=164 data-nosnippet>164</a> len
<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">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=#168 id=168 data-nosnippet>168</a> <span class="kw">let </span>last_will = <span class="kw">match </span>connect_flags &amp; <span class="number">0b100 </span>{
<a href=#169 id=169 data-nosnippet>169</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=#170 id=170 data-nosnippet>170</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::IncorrectPacketFormat);
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a> <span class="number">0 </span>=&gt; <span class="prelude-val">None</span>,
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw">_ </span>=&gt; {
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">let </span>will_topic = read_mqtt_string(bytes)<span class="question-mark">?</span>;
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span>will_message = read_mqtt_bytes(bytes)<span class="question-mark">?</span>;
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">let </span>will_qos = qos((connect_flags &amp; <span class="number">0b11000</span>) &gt;&gt; <span class="number">3</span>)<span class="question-mark">?</span>;
<a href=#177 id=177 data-nosnippet>177</a> <span class="prelude-val">Some</span>(LastWill {
<a href=#178 id=178 data-nosnippet>178</a> topic: will_topic,
<a href=#179 id=179 data-nosnippet>179</a> message: will_message,
<a href=#180 id=180 data-nosnippet>180</a> qos: will_qos,
<a href=#181 id=181 data-nosnippet>181</a> retain: (connect_flags &amp; <span class="number">0b0010_0000</span>) != <span class="number">0</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> };
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a> <span class="prelude-val">Ok</span>(last_will)
<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">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=#190 id=190 data-nosnippet>190</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</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=#193 id=193 data-nosnippet>193</a> <span class="kw">if </span><span class="self">self</span>.retain {
<a href=#194 id=194 data-nosnippet>194</a> connect_flags |= <span class="number">0x20</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> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.topic);
<a href=#198 id=198 data-nosnippet>198</a> write_mqtt_bytes(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.message);
<a href=#199 id=199 data-nosnippet>199</a> <span class="prelude-val">Ok</span>(connect_flags)
<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>
<a href=#203 id=203 data-nosnippet>203</a><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#204 id=204 data-nosnippet>204</a></span><span class="kw">pub struct </span>Login {
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">pub </span>username: String,
<a href=#206 id=206 data-nosnippet>206</a> <span class="kw">pub </span>password: String,
<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">impl </span>Login {
<a href=#210 id=210 data-nosnippet>210</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=#211 id=211 data-nosnippet>211</a> Login {
<a href=#212 id=212 data-nosnippet>212</a> username: u.into(),
<a href=#213 id=213 data-nosnippet>213</a> password: p.into(),
<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>
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">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=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span>username = <span class="kw">match </span>connect_flags &amp; <span class="number">0b1000_0000 </span>{
<a href=#219 id=219 data-nosnippet>219</a> <span class="number">0 </span>=&gt; String::new(),
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">_ </span>=&gt; read_mqtt_string(bytes)<span class="question-mark">?</span>,
<a href=#221 id=221 data-nosnippet>221</a> };
<a href=#222 id=222 data-nosnippet>222</a>
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">let </span>password = <span class="kw">match </span>connect_flags &amp; <span class="number">0b0100_0000 </span>{
<a href=#224 id=224 data-nosnippet>224</a> <span class="number">0 </span>=&gt; String::new(),
<a href=#225 id=225 data-nosnippet>225</a> <span class="kw">_ </span>=&gt; read_mqtt_string(bytes)<span class="question-mark">?</span>,
<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">if </span>username.is_empty() &amp;&amp; password.is_empty() {
<a href=#229 id=229 data-nosnippet>229</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
<a href=#230 id=230 data-nosnippet>230</a> } <span class="kw">else </span>{
<a href=#231 id=231 data-nosnippet>231</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(Login { username, password }))
<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>
<a href=#235 id=235 data-nosnippet>235</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#236 id=236 data-nosnippet>236</a> <span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
<a href=#237 id=237 data-nosnippet>237</a>
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">if </span>!<span class="self">self</span>.username.is_empty() {
<a href=#239 id=239 data-nosnippet>239</a> len += <span class="number">2 </span>+ <span class="self">self</span>.username.len();
<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="kw">if </span>!<span class="self">self</span>.password.is_empty() {
<a href=#243 id=243 data-nosnippet>243</a> len += <span class="number">2 </span>+ <span class="self">self</span>.password.len();
<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> len
<a href=#247 id=247 data-nosnippet>247</a> }
<a href=#248 id=248 data-nosnippet>248</a>
<a href=#249 id=249 data-nosnippet>249</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; u8 {
<a href=#250 id=250 data-nosnippet>250</a> <span class="kw">let </span><span class="kw-2">mut </span>connect_flags = <span class="number">0</span>;
<a href=#251 id=251 data-nosnippet>251</a> <span class="kw">if </span>!<span class="self">self</span>.username.is_empty() {
<a href=#252 id=252 data-nosnippet>252</a> connect_flags |= <span class="number">0x80</span>;
<a href=#253 id=253 data-nosnippet>253</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.username);
<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> <span class="kw">if </span>!<span class="self">self</span>.password.is_empty() {
<a href=#257 id=257 data-nosnippet>257</a> connect_flags |= <span class="number">0x40</span>;
<a href=#258 id=258 data-nosnippet>258</a> write_mqtt_string(buffer, <span class="kw-2">&amp;</span><span class="self">self</span>.password);
<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> connect_flags
<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">pub fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>, username: <span class="kw-2">&amp;</span>str, password: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#265 id=265 data-nosnippet>265</a> (<span class="self">self</span>.username == <span class="kw-2">*</span>username) &amp;&amp; (<span class="self">self</span>.password == <span class="kw-2">*</span>password)
<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>
<a href=#269 id=269 data-nosnippet>269</a><span class="attr">#[cfg(test)]
<a href=#270 id=270 data-nosnippet>270</a></span><span class="kw">mod </span>test {
<a href=#271 id=271 data-nosnippet>271</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#272 id=272 data-nosnippet>272</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#274 id=274 data-nosnippet>274</a>
<a href=#275 id=275 data-nosnippet>275</a> <span class="attr">#[test]
<a href=#276 id=276 data-nosnippet>276</a> </span><span class="kw">fn </span>connect_parsing_works() {
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = bytes::BytesMut::new();
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">let </span>packetstream = <span class="kw-2">&amp;</span>[
<a href=#279 id=279 data-nosnippet>279</a> <span class="number">0x10</span>,
<a href=#280 id=280 data-nosnippet>280</a> <span class="number">39</span>, <span class="comment">// packet type, flags and remaining len
<a href=#281 id=281 data-nosnippet>281</a> </span><span class="number">0x00</span>,
<a href=#282 id=282 data-nosnippet>282</a> <span class="number">0x04</span>,
<a href=#283 id=283 data-nosnippet>283</a> <span class="string">b'M'</span>,
<a href=#284 id=284 data-nosnippet>284</a> <span class="string">b'Q'</span>,
<a href=#285 id=285 data-nosnippet>285</a> <span class="string">b'T'</span>,
<a href=#286 id=286 data-nosnippet>286</a> <span class="string">b'T'</span>,
<a href=#287 id=287 data-nosnippet>287</a> <span class="number">0x04</span>, <span class="comment">// variable header
<a href=#288 id=288 data-nosnippet>288</a> </span><span class="number">0b1100_1110</span>, <span class="comment">// variable header. +username, +password, -will retain, will qos=1, +last_will, +clean_session
<a href=#289 id=289 data-nosnippet>289</a> </span><span class="number">0x00</span>,
<a href=#290 id=290 data-nosnippet>290</a> <span class="number">0x0a</span>, <span class="comment">// variable header. keep alive = 10 sec
<a href=#291 id=291 data-nosnippet>291</a> </span><span class="number">0x00</span>,
<a href=#292 id=292 data-nosnippet>292</a> <span class="number">0x04</span>,
<a href=#293 id=293 data-nosnippet>293</a> <span class="string">b't'</span>,
<a href=#294 id=294 data-nosnippet>294</a> <span class="string">b'e'</span>,
<a href=#295 id=295 data-nosnippet>295</a> <span class="string">b's'</span>,
<a href=#296 id=296 data-nosnippet>296</a> <span class="string">b't'</span>, <span class="comment">// payload. client_id
<a href=#297 id=297 data-nosnippet>297</a> </span><span class="number">0x00</span>,
<a href=#298 id=298 data-nosnippet>298</a> <span class="number">0x02</span>,
<a href=#299 id=299 data-nosnippet>299</a> <span class="string">b'/'</span>,
<a href=#300 id=300 data-nosnippet>300</a> <span class="string">b'a'</span>, <span class="comment">// payload. will topic = '/a'
<a href=#301 id=301 data-nosnippet>301</a> </span><span class="number">0x00</span>,
<a href=#302 id=302 data-nosnippet>302</a> <span class="number">0x07</span>,
<a href=#303 id=303 data-nosnippet>303</a> <span class="string">b'o'</span>,
<a href=#304 id=304 data-nosnippet>304</a> <span class="string">b'f'</span>,
<a href=#305 id=305 data-nosnippet>305</a> <span class="string">b'f'</span>,
<a href=#306 id=306 data-nosnippet>306</a> <span class="string">b'l'</span>,
<a href=#307 id=307 data-nosnippet>307</a> <span class="string">b'i'</span>,
<a href=#308 id=308 data-nosnippet>308</a> <span class="string">b'n'</span>,
<a href=#309 id=309 data-nosnippet>309</a> <span class="string">b'e'</span>, <span class="comment">// payload. variable header. will msg = 'offline'
<a href=#310 id=310 data-nosnippet>310</a> </span><span class="number">0x00</span>,
<a href=#311 id=311 data-nosnippet>311</a> <span class="number">0x04</span>,
<a href=#312 id=312 data-nosnippet>312</a> <span class="string">b'r'</span>,
<a href=#313 id=313 data-nosnippet>313</a> <span class="string">b'u'</span>,
<a href=#314 id=314 data-nosnippet>314</a> <span class="string">b'm'</span>,
<a href=#315 id=315 data-nosnippet>315</a> <span class="string">b'q'</span>, <span class="comment">// payload. username = 'rumq'
<a href=#316 id=316 data-nosnippet>316</a> </span><span class="number">0x00</span>,
<a href=#317 id=317 data-nosnippet>317</a> <span class="number">0x02</span>,
<a href=#318 id=318 data-nosnippet>318</a> <span class="string">b'm'</span>,
<a href=#319 id=319 data-nosnippet>319</a> <span class="string">b'q'</span>, <span class="comment">// payload. password = 'mq'
<a href=#320 id=320 data-nosnippet>320</a> </span><span class="number">0xDE</span>,
<a href=#321 id=321 data-nosnippet>321</a> <span class="number">0xAD</span>,
<a href=#322 id=322 data-nosnippet>322</a> <span class="number">0xBE</span>,
<a href=#323 id=323 data-nosnippet>323</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#324 id=324 data-nosnippet>324</a> </span>];
<a href=#325 id=325 data-nosnippet>325</a>
<a href=#326 id=326 data-nosnippet>326</a> stream.extend_from_slice(<span class="kw-2">&amp;</span>packetstream[..]);
<a href=#327 id=327 data-nosnippet>327</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#328 id=328 data-nosnippet>328</a> <span class="kw">let </span>connect_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#329 id=329 data-nosnippet>329</a> <span class="kw">let </span>packet = Connect::read(fixed_header, connect_bytes).unwrap();
<a href=#330 id=330 data-nosnippet>330</a>
<a href=#331 id=331 data-nosnippet>331</a> <span class="macro">assert_eq!</span>(
<a href=#332 id=332 data-nosnippet>332</a> packet,
<a href=#333 id=333 data-nosnippet>333</a> Connect {
<a href=#334 id=334 data-nosnippet>334</a> protocol: Protocol::V4,
<a href=#335 id=335 data-nosnippet>335</a> keep_alive: <span class="number">10</span>,
<a href=#336 id=336 data-nosnippet>336</a> client_id: <span class="string">"test"</span>.to_owned(),
<a href=#337 id=337 data-nosnippet>337</a> clean_session: <span class="bool-val">true</span>,
<a href=#338 id=338 data-nosnippet>338</a> last_will: <span class="prelude-val">Some</span>(LastWill::new(<span class="string">"/a"</span>, <span class="string">"offline"</span>, QoS::AtLeastOnce, <span class="bool-val">false</span>)),
<a href=#339 id=339 data-nosnippet>339</a> login: <span class="prelude-val">Some</span>(Login::new(<span class="string">"rumq"</span>, <span class="string">"mq"</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>
<a href=#344 id=344 data-nosnippet>344</a> <span class="kw">fn </span>sample_bytes() -&gt; Vec&lt;u8&gt; {
<a href=#345 id=345 data-nosnippet>345</a> <span class="macro">vec!</span>[
<a href=#346 id=346 data-nosnippet>346</a> <span class="number">0x10</span>,
<a href=#347 id=347 data-nosnippet>347</a> <span class="number">39</span>,
<a href=#348 id=348 data-nosnippet>348</a> <span class="number">0x00</span>,
<a href=#349 id=349 data-nosnippet>349</a> <span class="number">0x04</span>,
<a href=#350 id=350 data-nosnippet>350</a> <span class="string">b'M'</span>,
<a href=#351 id=351 data-nosnippet>351</a> <span class="string">b'Q'</span>,
<a href=#352 id=352 data-nosnippet>352</a> <span class="string">b'T'</span>,
<a href=#353 id=353 data-nosnippet>353</a> <span class="string">b'T'</span>,
<a href=#354 id=354 data-nosnippet>354</a> <span class="number">0x04</span>,
<a href=#355 id=355 data-nosnippet>355</a> <span class="number">0b1100_1110</span>, <span class="comment">// +username, +password, -will retain, will qos=1, +last_will, +clean_session
<a href=#356 id=356 data-nosnippet>356</a> </span><span class="number">0x00</span>,
<a href=#357 id=357 data-nosnippet>357</a> <span class="number">0x0a</span>, <span class="comment">// 10 sec
<a href=#358 id=358 data-nosnippet>358</a> </span><span class="number">0x00</span>,
<a href=#359 id=359 data-nosnippet>359</a> <span class="number">0x04</span>,
<a href=#360 id=360 data-nosnippet>360</a> <span class="string">b't'</span>,
<a href=#361 id=361 data-nosnippet>361</a> <span class="string">b'e'</span>,
<a href=#362 id=362 data-nosnippet>362</a> <span class="string">b's'</span>,
<a href=#363 id=363 data-nosnippet>363</a> <span class="string">b't'</span>, <span class="comment">// client_id
<a href=#364 id=364 data-nosnippet>364</a> </span><span class="number">0x00</span>,
<a href=#365 id=365 data-nosnippet>365</a> <span class="number">0x02</span>,
<a href=#366 id=366 data-nosnippet>366</a> <span class="string">b'/'</span>,
<a href=#367 id=367 data-nosnippet>367</a> <span class="string">b'a'</span>, <span class="comment">// will topic = '/a'
<a href=#368 id=368 data-nosnippet>368</a> </span><span class="number">0x00</span>,
<a href=#369 id=369 data-nosnippet>369</a> <span class="number">0x07</span>,
<a href=#370 id=370 data-nosnippet>370</a> <span class="string">b'o'</span>,
<a href=#371 id=371 data-nosnippet>371</a> <span class="string">b'f'</span>,
<a href=#372 id=372 data-nosnippet>372</a> <span class="string">b'f'</span>,
<a href=#373 id=373 data-nosnippet>373</a> <span class="string">b'l'</span>,
<a href=#374 id=374 data-nosnippet>374</a> <span class="string">b'i'</span>,
<a href=#375 id=375 data-nosnippet>375</a> <span class="string">b'n'</span>,
<a href=#376 id=376 data-nosnippet>376</a> <span class="string">b'e'</span>, <span class="comment">// will msg = 'offline'
<a href=#377 id=377 data-nosnippet>377</a> </span><span class="number">0x00</span>,
<a href=#378 id=378 data-nosnippet>378</a> <span class="number">0x04</span>,
<a href=#379 id=379 data-nosnippet>379</a> <span class="string">b'r'</span>,
<a href=#380 id=380 data-nosnippet>380</a> <span class="string">b'u'</span>,
<a href=#381 id=381 data-nosnippet>381</a> <span class="string">b's'</span>,
<a href=#382 id=382 data-nosnippet>382</a> <span class="string">b't'</span>, <span class="comment">// username = 'rust'
<a href=#383 id=383 data-nosnippet>383</a> </span><span class="number">0x00</span>,
<a href=#384 id=384 data-nosnippet>384</a> <span class="number">0x02</span>,
<a href=#385 id=385 data-nosnippet>385</a> <span class="string">b'm'</span>,
<a href=#386 id=386 data-nosnippet>386</a> <span class="string">b'q'</span>, <span class="comment">// password = 'mq'
<a href=#387 id=387 data-nosnippet>387</a> </span>]
<a href=#388 id=388 data-nosnippet>388</a> }
<a href=#389 id=389 data-nosnippet>389</a>
<a href=#390 id=390 data-nosnippet>390</a> <span class="attr">#[test]
<a href=#391 id=391 data-nosnippet>391</a> </span><span class="kw">fn </span>connect_encoding_works() {
<a href=#392 id=392 data-nosnippet>392</a> <span class="kw">let </span>connect = Connect {
<a href=#393 id=393 data-nosnippet>393</a> protocol: Protocol::V4,
<a href=#394 id=394 data-nosnippet>394</a> keep_alive: <span class="number">10</span>,
<a href=#395 id=395 data-nosnippet>395</a> client_id: <span class="string">"test"</span>.to_owned(),
<a href=#396 id=396 data-nosnippet>396</a> clean_session: <span class="bool-val">true</span>,
<a href=#397 id=397 data-nosnippet>397</a> last_will: <span class="prelude-val">Some</span>(LastWill::new(<span class="string">"/a"</span>, <span class="string">"offline"</span>, QoS::AtLeastOnce, <span class="bool-val">false</span>)),
<a href=#398 id=398 data-nosnippet>398</a> login: <span class="prelude-val">Some</span>(Login::new(<span class="string">"rust"</span>, <span class="string">"mq"</span>)),
<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> <span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
<a href=#402 id=402 data-nosnippet>402</a> connect.write(<span class="kw-2">&amp;mut </span>buf).unwrap();
<a href=#403 id=403 data-nosnippet>403</a>
<a href=#404 id=404 data-nosnippet>404</a> <span class="comment">// println!("{:?}", &amp;buf[..]);
<a href=#405 id=405 data-nosnippet>405</a> // println!("{:?}", sample_bytes());
<a href=#406 id=406 data-nosnippet>406</a>
<a href=#407 id=407 data-nosnippet>407</a> </span><span class="macro">assert_eq!</span>(buf, sample_bytes());
<a href=#408 id=408 data-nosnippet>408</a> }
<a href=#409 id=409 data-nosnippet>409</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,16 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>disconnect.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>Disconnect;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">impl </span>Disconnect {
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#9 id=9 data-nosnippet>9</a> <span class="number">2
<a href=#10 id=10 data-nosnippet>10</a> </span>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#13 id=13 data-nosnippet>13</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xE0</span>, <span class="number">0x00</span>]);
<a href=#14 id=14 data-nosnippet>14</a> <span class="prelude-val">Ok</span>(<span class="number">2</span>)
<a href=#15 id=15 data-nosnippet>15</a> }
<a href=#16 id=16 data-nosnippet>16</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,100 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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 super</span>::<span class="kw-2">*</span>;
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">mod </span>connack;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">mod </span>connect;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">mod </span>disconnect;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>ping;
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">mod </span>puback;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">mod </span>pubcomp;
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">mod </span>publish;
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">mod </span>pubrec;
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">mod </span>pubrel;
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">mod </span>suback;
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">mod </span>subscribe;
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">mod </span>unsuback;
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">mod </span>unsubscribe;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">pub use </span>connack::<span class="kw-2">*</span>;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub use </span>connect::<span class="kw-2">*</span>;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub use </span>disconnect::<span class="kw-2">*</span>;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">pub use </span>ping::<span class="kw-2">*</span>;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">pub use </span>puback::<span class="kw-2">*</span>;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">pub use </span>pubcomp::<span class="kw-2">*</span>;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub use </span>publish::<span class="kw-2">*</span>;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub use </span>pubrec::<span class="kw-2">*</span>;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub use </span>pubrel::<span class="kw-2">*</span>;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">pub use </span>suback::<span class="kw-2">*</span>;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">pub use </span>subscribe::<span class="kw-2">*</span>;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">pub use </span>unsuback::<span class="kw-2">*</span>;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">pub use </span>unsubscribe::<span class="kw-2">*</span>;
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="doccomment">/// Encapsulates all MQTT packet types
<a href=#32 id=32 data-nosnippet>32</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub enum </span>Packet {
<a href=#34 id=34 data-nosnippet>34</a> Connect(Connect),
<a href=#35 id=35 data-nosnippet>35</a> ConnAck(ConnAck),
<a href=#36 id=36 data-nosnippet>36</a> Publish(Publish),
<a href=#37 id=37 data-nosnippet>37</a> PubAck(PubAck),
<a href=#38 id=38 data-nosnippet>38</a> PubRec(PubRec),
<a href=#39 id=39 data-nosnippet>39</a> PubRel(PubRel),
<a href=#40 id=40 data-nosnippet>40</a> PubComp(PubComp),
<a href=#41 id=41 data-nosnippet>41</a> Subscribe(Subscribe),
<a href=#42 id=42 data-nosnippet>42</a> SubAck(SubAck),
<a href=#43 id=43 data-nosnippet>43</a> Unsubscribe(Unsubscribe),
<a href=#44 id=44 data-nosnippet>44</a> UnsubAck(UnsubAck),
<a href=#45 id=45 data-nosnippet>45</a> PingReq,
<a href=#46 id=46 data-nosnippet>46</a> PingResp,
<a href=#47 id=47 data-nosnippet>47</a> Disconnect,
<a href=#48 id=48 data-nosnippet>48</a>}
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a><span class="doccomment">/// Reads a stream of bytes and extracts next MQTT packet out of it
<a href=#51 id=51 data-nosnippet>51</a></span><span class="kw">pub fn </span>read(stream: <span class="kw-2">&amp;mut </span>BytesMut, max_size: usize) -&gt; <span class="prelude-ty">Result</span>&lt;Packet, Error&gt; {
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>fixed_header = check(stream.iter(), max_size)<span class="question-mark">?</span>;
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> <span class="comment">// Test with a stream with exactly the size to check border panics
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">let </span>packet = stream.split_to(fixed_header.frame_length());
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>packet_type = fixed_header.packet_type()<span class="question-mark">?</span>;
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">0 </span>{
<a href=#59 id=59 data-nosnippet>59</a> <span class="comment">// no payload packets
<a href=#60 id=60 data-nosnippet>60</a> </span><span class="kw">return match </span>packet_type {
<a href=#61 id=61 data-nosnippet>61</a> PacketType::PingReq =&gt; <span class="prelude-val">Ok</span>(Packet::PingReq),
<a href=#62 id=62 data-nosnippet>62</a> PacketType::PingResp =&gt; <span class="prelude-val">Ok</span>(Packet::PingResp),
<a href=#63 id=63 data-nosnippet>63</a> PacketType::Disconnect =&gt; <span class="prelude-val">Ok</span>(Packet::Disconnect),
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(Error::PayloadRequired),
<a href=#65 id=65 data-nosnippet>65</a> };
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>packet = packet.freeze();
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">let </span>packet = <span class="kw">match </span>packet_type {
<a href=#70 id=70 data-nosnippet>70</a> PacketType::Connect =&gt; Packet::Connect(Connect::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#71 id=71 data-nosnippet>71</a> PacketType::ConnAck =&gt; Packet::ConnAck(ConnAck::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#72 id=72 data-nosnippet>72</a> PacketType::Publish =&gt; Packet::Publish(Publish::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#73 id=73 data-nosnippet>73</a> PacketType::PubAck =&gt; Packet::PubAck(PubAck::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#74 id=74 data-nosnippet>74</a> PacketType::PubRec =&gt; Packet::PubRec(PubRec::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#75 id=75 data-nosnippet>75</a> PacketType::PubRel =&gt; Packet::PubRel(PubRel::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#76 id=76 data-nosnippet>76</a> PacketType::PubComp =&gt; Packet::PubComp(PubComp::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#77 id=77 data-nosnippet>77</a> PacketType::Subscribe =&gt; Packet::Subscribe(Subscribe::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#78 id=78 data-nosnippet>78</a> PacketType::SubAck =&gt; Packet::SubAck(SubAck::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#79 id=79 data-nosnippet>79</a> PacketType::Unsubscribe =&gt; Packet::Unsubscribe(Unsubscribe::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#80 id=80 data-nosnippet>80</a> PacketType::UnsubAck =&gt; Packet::UnsubAck(UnsubAck::read(fixed_header, packet)<span class="question-mark">?</span>),
<a href=#81 id=81 data-nosnippet>81</a> PacketType::PingReq =&gt; Packet::PingReq,
<a href=#82 id=82 data-nosnippet>82</a> PacketType::PingResp =&gt; Packet::PingResp,
<a href=#83 id=83 data-nosnippet>83</a> PacketType::Disconnect =&gt; Packet::Disconnect,
<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="prelude-val">Ok</span>(packet)
<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="doccomment">/// Return number of remaining length bytes required for encoding length
<a href=#90 id=90 data-nosnippet>90</a></span><span class="kw">fn </span>len_len(len: usize) -&gt; usize {
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">if </span>len &gt;= <span class="number">2_097_152 </span>{
<a href=#92 id=92 data-nosnippet>92</a> <span class="number">4
<a href=#93 id=93 data-nosnippet>93</a> </span>} <span class="kw">else if </span>len &gt;= <span class="number">16_384 </span>{
<a href=#94 id=94 data-nosnippet>94</a> <span class="number">3
<a href=#95 id=95 data-nosnippet>95</a> </span>} <span class="kw">else if </span>len &gt;= <span class="number">128 </span>{
<a href=#96 id=96 data-nosnippet>96</a> <span class="number">2
<a href=#97 id=97 data-nosnippet>97</a> </span>} <span class="kw">else </span>{
<a href=#98 id=98 data-nosnippet>98</a> <span class="number">1
<a href=#99 id=99 data-nosnippet>99</a> </span>}
<a href=#100 id=100 data-nosnippet>100</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,30 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#9 id=9 data-nosnippet>9</a> <span class="number">2
<a href=#10 id=10 data-nosnippet>10</a> </span>}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#13 id=13 data-nosnippet>13</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xC0</span>, <span class="number">0x00</span>]);
<a href=#14 id=14 data-nosnippet>14</a> <span class="prelude-val">Ok</span>(<span class="number">2</span>)
<a href=#15 id=15 data-nosnippet>15</a> }
<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="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">pub struct </span>PingResp;
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">impl </span>PingResp {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#23 id=23 data-nosnippet>23</a> <span class="number">2
<a href=#24 id=24 data-nosnippet>24</a> </span>}
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#27 id=27 data-nosnippet>27</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xD0</span>, <span class="number">0x00</span>]);
<a href=#28 id=28 data-nosnippet>28</a> <span class="prelude-val">Ok</span>(<span class="number">2</span>)
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,81 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>puback.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::{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 QoS1 publish
<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>PubAck {
<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>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>PubAck {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub fn </span>new(pkid: u16) -&gt; PubAck {
<a href=#12 id=12 data-nosnippet>12</a> PubAck { pkid }
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#16 id=16 data-nosnippet>16</a> <span class="comment">// pkid
<a href=#17 id=17 data-nosnippet>17</a> </span><span class="number">2
<a href=#18 id=18 data-nosnippet>18</a> </span>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="number">1 </span>+ remaining_len_size + len
<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">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=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#29 id=29 data-nosnippet>29</a> bytes.advance(variable_header_index);
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="comment">// No reason code or properties if remaining length == 2
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubAck { pkid });
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="comment">// No properties len or properties if remaining len &gt; 2 but &lt; 4
<a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubAck { pkid });
<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> <span class="kw">let </span>puback = PubAck { pkid };
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a> <span class="prelude-val">Ok</span>(puback)
<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="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=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#49 id=49 data-nosnippet>49</a> buffer.put_u8(<span class="number">0x40</span>);
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#51 id=51 data-nosnippet>51</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#52 id=52 data-nosnippet>52</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<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>
<a href=#56 id=56 data-nosnippet>56</a><span class="attr">#[cfg(test)]
<a href=#57 id=57 data-nosnippet>57</a></span><span class="kw">mod </span>test {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="attr">#[test]
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">fn </span>puback_encoding_works() {
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>stream = <span class="kw-2">&amp;</span>[
<a href=#65 id=65 data-nosnippet>65</a> <span class="number">0b0100_0000</span>,
<a href=#66 id=66 data-nosnippet>66</a> <span class="number">0x02</span>, <span class="comment">// packet type, flags and remaining len
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="number">0x00</span>,
<a href=#68 id=68 data-nosnippet>68</a> <span class="number">0x0A</span>, <span class="comment">// fixed header. packet identifier = 10
<a href=#69 id=69 data-nosnippet>69</a> </span><span class="number">0xDE</span>,
<a href=#70 id=70 data-nosnippet>70</a> <span class="number">0xAD</span>,
<a href=#71 id=71 data-nosnippet>71</a> <span class="number">0xBE</span>,
<a href=#72 id=72 data-nosnippet>72</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#73 id=73 data-nosnippet>73</a> </span>];
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = BytesMut::from(<span class="kw-2">&amp;</span>stream[..]);
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>ack_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">let </span>packet = PubAck::read(fixed_header, ack_bytes).unwrap();
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="macro">assert_eq!</span>(packet, PubAck { pkid: <span class="number">10 </span>});
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,51 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>pubcomp.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::{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">/// QoS2 Assured publish complete, in response to PUBREL packet
<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>PubComp {
<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>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>PubComp {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub fn </span>new(pkid: u16) -&gt; PubComp {
<a href=#12 id=12 data-nosnippet>12</a> PubComp { pkid }
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#18 id=18 data-nosnippet>18</a> <span class="number">1 </span>+ remaining_len_size + len
<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">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#22 id=22 data-nosnippet>22</a> <span class="comment">// pkid
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="number">2
<a href=#24 id=24 data-nosnippet>24</a> </span>}
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</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=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#28 id=28 data-nosnippet>28</a> bytes.advance(variable_header_index);
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubComp { pkid });
<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">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubComp { pkid });
<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">let </span>puback = PubComp { pkid };
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="prelude-val">Ok</span>(puback)
<a href=#42 id=42 data-nosnippet>42</a> }
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</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=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#46 id=46 data-nosnippet>46</a> buffer.put_u8(<span class="number">0x70</span>);
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#48 id=48 data-nosnippet>48</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#49 id=49 data-nosnippet>49</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,274 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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, PartialEq, Eq)]
<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: String,
<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>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">impl </span>Publish {
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;, P: Into&lt;Vec&lt;u8&gt;&gt;&gt;(topic: S, qos: QoS, payload: P) -&gt; Publish {
<a href=#17 id=17 data-nosnippet>17</a> Publish {
<a href=#18 id=18 data-nosnippet>18</a> dup: <span class="bool-val">false</span>,
<a href=#19 id=19 data-nosnippet>19</a> qos,
<a href=#20 id=20 data-nosnippet>20</a> retain: <span class="bool-val">false</span>,
<a href=#21 id=21 data-nosnippet>21</a> pkid: <span class="number">0</span>,
<a href=#22 id=22 data-nosnippet>22</a> topic: topic.into(),
<a href=#23 id=23 data-nosnippet>23</a> payload: Bytes::from(payload.into()),
<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>
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">pub fn </span>from_bytes&lt;S: Into&lt;String&gt;&gt;(topic: S, qos: QoS, payload: Bytes) -&gt; Publish {
<a href=#28 id=28 data-nosnippet>28</a> Publish {
<a href=#29 id=29 data-nosnippet>29</a> dup: <span class="bool-val">false</span>,
<a href=#30 id=30 data-nosnippet>30</a> qos,
<a href=#31 id=31 data-nosnippet>31</a> retain: <span class="bool-val">false</span>,
<a href=#32 id=32 data-nosnippet>32</a> pkid: <span class="number">0</span>,
<a href=#33 id=33 data-nosnippet>33</a> topic: topic.into(),
<a href=#34 id=34 data-nosnippet>34</a> payload,
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a> }
<a href=#37 id=37 data-nosnippet>37</a>
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>len = <span class="number">2 </span>+ <span class="self">self</span>.topic.len() + <span class="self">self</span>.payload.len();
<a href=#40 id=40 data-nosnippet>40</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=#41 id=41 data-nosnippet>41</a> len + <span class="number">2
<a href=#42 id=42 data-nosnippet>42</a> </span>} <span class="kw">else </span>{
<a href=#43 id=43 data-nosnippet>43</a> len
<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>
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="number">1 </span>+ remaining_len_size + 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;<span class="self">Self</span>, Error&gt; {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>qos = qos((fixed_header.byte1 &amp; <span class="number">0b0110</span>) &gt;&gt; <span class="number">1</span>)<span class="question-mark">?</span>;
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>dup = (fixed_header.byte1 &amp; <span class="number">0b1000</span>) != <span class="number">0</span>;
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span>retain = (fixed_header.byte1 &amp; <span class="number">0b0001</span>) != <span class="number">0</span>;
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#60 id=60 data-nosnippet>60</a> bytes.advance(variable_header_index);
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>topic = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<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="comment">// Packet identifier exists where QoS &gt; 0
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">let </span>pkid = <span class="kw">match </span>qos {
<a href=#65 id=65 data-nosnippet>65</a> QoS::AtMostOnce =&gt; <span class="number">0</span>,
<a href=#66 id=66 data-nosnippet>66</a> QoS::AtLeastOnce | QoS::ExactlyOnce =&gt; read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>,
<a href=#67 id=67 data-nosnippet>67</a> };
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">if </span>qos != QoS::AtMostOnce &amp;&amp; pkid == <span class="number">0 </span>{
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PacketIdZero);
<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>publish = Publish {
<a href=#74 id=74 data-nosnippet>74</a> dup,
<a href=#75 id=75 data-nosnippet>75</a> retain,
<a href=#76 id=76 data-nosnippet>76</a> qos,
<a href=#77 id=77 data-nosnippet>77</a> pkid,
<a href=#78 id=78 data-nosnippet>78</a> topic,
<a href=#79 id=79 data-nosnippet>79</a> payload: bytes,
<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>(publish)
<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();
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span>dup = <span class="self">self</span>.dup <span class="kw">as </span>u8;
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>qos = <span class="self">self</span>.qos <span class="kw">as </span>u8;
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">let </span>retain = <span class="self">self</span>.retain <span class="kw">as </span>u8;
<a href=#91 id=91 data-nosnippet>91</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=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#94 id=94 data-nosnippet>94</a> write_mqtt_string(buffer, <span class="self">self</span>.topic.as_str());
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">if </span><span class="self">self</span>.qos != QoS::AtMostOnce {
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>pkid = <span class="self">self</span>.pkid;
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">if </span>pkid == <span class="number">0 </span>{
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PacketIdZero);
<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> buffer.put_u16(pkid);
<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.extend_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.payload);
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="comment">// TODO: Returned length is wrong in other packets. Fix it
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<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>
<a href=#112 id=112 data-nosnippet>112</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Publish {
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#114 id=114 data-nosnippet>114</a> <span class="macro">write!</span>(
<a href=#115 id=115 data-nosnippet>115</a> f,
<a href=#116 id=116 data-nosnippet>116</a> <span class="string">"Topic = {}, Qos = {:?}, Retain = {}, Pkid = {:?}, Payload Size = {}"</span>,
<a href=#117 id=117 data-nosnippet>117</a> <span class="self">self</span>.topic,
<a href=#118 id=118 data-nosnippet>118</a> <span class="self">self</span>.qos,
<a href=#119 id=119 data-nosnippet>119</a> <span class="self">self</span>.retain,
<a href=#120 id=120 data-nosnippet>120</a> <span class="self">self</span>.pkid,
<a href=#121 id=121 data-nosnippet>121</a> <span class="self">self</span>.payload.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>
<a href=#126 id=126 data-nosnippet>126</a><span class="attr">#[cfg(test)]
<a href=#127 id=127 data-nosnippet>127</a></span><span class="kw">mod </span>test {
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">use </span>bytes::{Bytes, BytesMut};
<a href=#130 id=130 data-nosnippet>130</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="attr">#[test]
<a href=#133 id=133 data-nosnippet>133</a> </span><span class="kw">fn </span>qos1_publish_parsing_works() {
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">let </span>stream = <span class="kw-2">&amp;</span>[
<a href=#135 id=135 data-nosnippet>135</a> <span class="number">0b0011_0010</span>,
<a href=#136 id=136 data-nosnippet>136</a> <span class="number">11</span>, <span class="comment">// packet type, flags and remaining len
<a href=#137 id=137 data-nosnippet>137</a> </span><span class="number">0x00</span>,
<a href=#138 id=138 data-nosnippet>138</a> <span class="number">0x03</span>,
<a href=#139 id=139 data-nosnippet>139</a> <span class="string">b'a'</span>,
<a href=#140 id=140 data-nosnippet>140</a> <span class="string">b'/'</span>,
<a href=#141 id=141 data-nosnippet>141</a> <span class="string">b'b'</span>, <span class="comment">// variable header. topic name = 'a/b'
<a href=#142 id=142 data-nosnippet>142</a> </span><span class="number">0x00</span>,
<a href=#143 id=143 data-nosnippet>143</a> <span class="number">0x0a</span>, <span class="comment">// variable header. pkid = 10
<a href=#144 id=144 data-nosnippet>144</a> </span><span class="number">0xF1</span>,
<a href=#145 id=145 data-nosnippet>145</a> <span class="number">0xF2</span>,
<a href=#146 id=146 data-nosnippet>146</a> <span class="number">0xF3</span>,
<a href=#147 id=147 data-nosnippet>147</a> <span class="number">0xF4</span>, <span class="comment">// publish payload
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="number">0xDE</span>,
<a href=#149 id=149 data-nosnippet>149</a> <span class="number">0xAD</span>,
<a href=#150 id=150 data-nosnippet>150</a> <span class="number">0xBE</span>,
<a href=#151 id=151 data-nosnippet>151</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#152 id=152 data-nosnippet>152</a> </span>];
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = BytesMut::from(<span class="kw-2">&amp;</span>stream[..]);
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>publish_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw">let </span>packet = Publish::read(fixed_header, publish_bytes).unwrap();
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">let </span>payload = <span class="kw-2">&amp;</span>[<span class="number">0xF1</span>, <span class="number">0xF2</span>, <span class="number">0xF3</span>, <span class="number">0xF4</span>];
<a href=#160 id=160 data-nosnippet>160</a> <span class="macro">assert_eq!</span>(
<a href=#161 id=161 data-nosnippet>161</a> packet,
<a href=#162 id=162 data-nosnippet>162</a> Publish {
<a href=#163 id=163 data-nosnippet>163</a> dup: <span class="bool-val">false</span>,
<a href=#164 id=164 data-nosnippet>164</a> qos: QoS::AtLeastOnce,
<a href=#165 id=165 data-nosnippet>165</a> retain: <span class="bool-val">false</span>,
<a href=#166 id=166 data-nosnippet>166</a> topic: <span class="string">"a/b"</span>.to_owned(),
<a href=#167 id=167 data-nosnippet>167</a> pkid: <span class="number">10</span>,
<a href=#168 id=168 data-nosnippet>168</a> payload: Bytes::from(<span class="kw-2">&amp;</span>payload[..]),
<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> }
<a href=#172 id=172 data-nosnippet>172</a>
<a href=#173 id=173 data-nosnippet>173</a> <span class="attr">#[test]
<a href=#174 id=174 data-nosnippet>174</a> </span><span class="kw">fn </span>qos0_publish_parsing_works() {
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span>stream = <span class="kw-2">&amp;</span>[
<a href=#176 id=176 data-nosnippet>176</a> <span class="number">0b0011_0000</span>,
<a href=#177 id=177 data-nosnippet>177</a> <span class="number">7</span>, <span class="comment">// packet type, flags and remaining len
<a href=#178 id=178 data-nosnippet>178</a> </span><span class="number">0x00</span>,
<a href=#179 id=179 data-nosnippet>179</a> <span class="number">0x03</span>,
<a href=#180 id=180 data-nosnippet>180</a> <span class="string">b'a'</span>,
<a href=#181 id=181 data-nosnippet>181</a> <span class="string">b'/'</span>,
<a href=#182 id=182 data-nosnippet>182</a> <span class="string">b'b'</span>, <span class="comment">// variable header. topic name = 'a/b'
<a href=#183 id=183 data-nosnippet>183</a> </span><span class="number">0x01</span>,
<a href=#184 id=184 data-nosnippet>184</a> <span class="number">0x02</span>, <span class="comment">// payload
<a href=#185 id=185 data-nosnippet>185</a> </span><span class="number">0xDE</span>,
<a href=#186 id=186 data-nosnippet>186</a> <span class="number">0xAD</span>,
<a href=#187 id=187 data-nosnippet>187</a> <span class="number">0xBE</span>,
<a href=#188 id=188 data-nosnippet>188</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#189 id=189 data-nosnippet>189</a> </span>];
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = BytesMut::from(<span class="kw-2">&amp;</span>stream[..]);
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw">let </span>publish_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#194 id=194 data-nosnippet>194</a> <span class="kw">let </span>packet = Publish::read(fixed_header, publish_bytes).unwrap();
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a> <span class="macro">assert_eq!</span>(
<a href=#197 id=197 data-nosnippet>197</a> packet,
<a href=#198 id=198 data-nosnippet>198</a> Publish {
<a href=#199 id=199 data-nosnippet>199</a> dup: <span class="bool-val">false</span>,
<a href=#200 id=200 data-nosnippet>200</a> qos: QoS::AtMostOnce,
<a href=#201 id=201 data-nosnippet>201</a> retain: <span class="bool-val">false</span>,
<a href=#202 id=202 data-nosnippet>202</a> topic: <span class="string">"a/b"</span>.to_owned(),
<a href=#203 id=203 data-nosnippet>203</a> pkid: <span class="number">0</span>,
<a href=#204 id=204 data-nosnippet>204</a> payload: Bytes::from(<span class="kw-2">&amp;</span>[<span class="number">0x01</span>, <span class="number">0x02</span>][..]),
<a href=#205 id=205 data-nosnippet>205</a> }
<a href=#206 id=206 data-nosnippet>206</a> );
<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="attr">#[test]
<a href=#210 id=210 data-nosnippet>210</a> </span><span class="kw">fn </span>qos1_publish_encoding_works() {
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">let </span>publish = Publish {
<a href=#212 id=212 data-nosnippet>212</a> dup: <span class="bool-val">false</span>,
<a href=#213 id=213 data-nosnippet>213</a> qos: QoS::AtLeastOnce,
<a href=#214 id=214 data-nosnippet>214</a> retain: <span class="bool-val">false</span>,
<a href=#215 id=215 data-nosnippet>215</a> topic: <span class="string">"a/b"</span>.to_owned(),
<a href=#216 id=216 data-nosnippet>216</a> pkid: <span class="number">10</span>,
<a href=#217 id=217 data-nosnippet>217</a> payload: Bytes::from(<span class="macro">vec!</span>[<span class="number">0xF1</span>, <span class="number">0xF2</span>, <span class="number">0xF3</span>, <span class="number">0xF4</span>]),
<a href=#218 id=218 data-nosnippet>218</a> };
<a href=#219 id=219 data-nosnippet>219</a>
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
<a href=#221 id=221 data-nosnippet>221</a> publish.write(<span class="kw-2">&amp;mut </span>buf).unwrap();
<a href=#222 id=222 data-nosnippet>222</a>
<a href=#223 id=223 data-nosnippet>223</a> <span class="macro">assert_eq!</span>(
<a href=#224 id=224 data-nosnippet>224</a> buf,
<a href=#225 id=225 data-nosnippet>225</a> <span class="macro">vec!</span>[
<a href=#226 id=226 data-nosnippet>226</a> <span class="number">0b0011_0010</span>,
<a href=#227 id=227 data-nosnippet>227</a> <span class="number">11</span>,
<a href=#228 id=228 data-nosnippet>228</a> <span class="number">0x00</span>,
<a href=#229 id=229 data-nosnippet>229</a> <span class="number">0x03</span>,
<a href=#230 id=230 data-nosnippet>230</a> <span class="string">b'a'</span>,
<a href=#231 id=231 data-nosnippet>231</a> <span class="string">b'/'</span>,
<a href=#232 id=232 data-nosnippet>232</a> <span class="string">b'b'</span>,
<a href=#233 id=233 data-nosnippet>233</a> <span class="number">0x00</span>,
<a href=#234 id=234 data-nosnippet>234</a> <span class="number">0x0a</span>,
<a href=#235 id=235 data-nosnippet>235</a> <span class="number">0xF1</span>,
<a href=#236 id=236 data-nosnippet>236</a> <span class="number">0xF2</span>,
<a href=#237 id=237 data-nosnippet>237</a> <span class="number">0xF3</span>,
<a href=#238 id=238 data-nosnippet>238</a> <span class="number">0xF4
<a href=#239 id=239 data-nosnippet>239</a> </span>]
<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>
<a href=#243 id=243 data-nosnippet>243</a> <span class="attr">#[test]
<a href=#244 id=244 data-nosnippet>244</a> </span><span class="kw">fn </span>qos0_publish_encoding_works() {
<a href=#245 id=245 data-nosnippet>245</a> <span class="kw">let </span>publish = Publish {
<a href=#246 id=246 data-nosnippet>246</a> dup: <span class="bool-val">false</span>,
<a href=#247 id=247 data-nosnippet>247</a> qos: QoS::AtMostOnce,
<a href=#248 id=248 data-nosnippet>248</a> retain: <span class="bool-val">false</span>,
<a href=#249 id=249 data-nosnippet>249</a> topic: <span class="string">"a/b"</span>.to_owned(),
<a href=#250 id=250 data-nosnippet>250</a> pkid: <span class="number">0</span>,
<a href=#251 id=251 data-nosnippet>251</a> payload: Bytes::from(<span class="macro">vec!</span>[<span class="number">0xE1</span>, <span class="number">0xE2</span>, <span class="number">0xE3</span>, <span class="number">0xE4</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">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
<a href=#255 id=255 data-nosnippet>255</a> publish.write(<span class="kw-2">&amp;mut </span>buf).unwrap();
<a href=#256 id=256 data-nosnippet>256</a>
<a href=#257 id=257 data-nosnippet>257</a> <span class="macro">assert_eq!</span>(
<a href=#258 id=258 data-nosnippet>258</a> buf,
<a href=#259 id=259 data-nosnippet>259</a> <span class="macro">vec!</span>[
<a href=#260 id=260 data-nosnippet>260</a> <span class="number">0b0011_0000</span>,
<a href=#261 id=261 data-nosnippet>261</a> <span class="number">9</span>,
<a href=#262 id=262 data-nosnippet>262</a> <span class="number">0x00</span>,
<a href=#263 id=263 data-nosnippet>263</a> <span class="number">0x03</span>,
<a href=#264 id=264 data-nosnippet>264</a> <span class="string">b'a'</span>,
<a href=#265 id=265 data-nosnippet>265</a> <span class="string">b'/'</span>,
<a href=#266 id=266 data-nosnippet>266</a> <span class="string">b'b'</span>,
<a href=#267 id=267 data-nosnippet>267</a> <span class="number">0xE1</span>,
<a href=#268 id=268 data-nosnippet>268</a> <span class="number">0xE2</span>,
<a href=#269 id=269 data-nosnippet>269</a> <span class="number">0xE3</span>,
<a href=#270 id=270 data-nosnippet>270</a> <span class="number">0xE4
<a href=#271 id=271 data-nosnippet>271</a> </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>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,51 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>pubrec.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::{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 QoS2 publish
<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>PubRec {
<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>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>PubRec {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub fn </span>new(pkid: u16) -&gt; PubRec {
<a href=#12 id=12 data-nosnippet>12</a> PubRec { pkid }
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#16 id=16 data-nosnippet>16</a> <span class="comment">// pkid
<a href=#17 id=17 data-nosnippet>17</a> </span><span class="number">2
<a href=#18 id=18 data-nosnippet>18</a> </span>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="number">1 </span>+ remaining_len_size + len
<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">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=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#29 id=29 data-nosnippet>29</a> bytes.advance(variable_header_index);
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRec { pkid });
<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">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRec { pkid });
<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">let </span>puback = PubRec { pkid };
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="prelude-val">Ok</span>(puback)
<a href=#42 id=42 data-nosnippet>42</a> }
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</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=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#46 id=46 data-nosnippet>46</a> buffer.put_u8(<span class="number">0x50</span>);
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#48 id=48 data-nosnippet>48</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#49 id=49 data-nosnippet>49</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,51 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>pubrel.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::{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">/// QoS2 Publish release, in response to PUBREC packet
<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>PubRel {
<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>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>PubRel {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub fn </span>new(pkid: u16) -&gt; PubRel {
<a href=#12 id=12 data-nosnippet>12</a> PubRel { pkid }
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#16 id=16 data-nosnippet>16</a> <span class="comment">// pkid
<a href=#17 id=17 data-nosnippet>17</a> </span><span class="number">2
<a href=#18 id=18 data-nosnippet>18</a> </span>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="number">1 </span>+ remaining_len_size + len
<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">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=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#29 id=29 data-nosnippet>29</a> bytes.advance(variable_header_index);
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">if </span>fixed_header.remaining_len == <span class="number">2 </span>{
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRel { pkid });
<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">if </span>fixed_header.remaining_len &lt; <span class="number">4 </span>{
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(PubRel { pkid });
<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">let </span>puback = PubRel { pkid };
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="prelude-val">Ok</span>(puback)
<a href=#42 id=42 data-nosnippet>42</a> }
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</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=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#46 id=46 data-nosnippet>46</a> buffer.put_u8(<span class="number">0x62</span>);
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>count = write_remaining_length(buffer, len)<span class="question-mark">?</span>;
<a href=#48 id=48 data-nosnippet>48</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#49 id=49 data-nosnippet>49</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ count + len)
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,118 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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><span class="kw">use </span>std::convert::{TryFrom, TryInto};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// Acknowledgement to subscribe
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub struct </span>SubAck {
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>pkid: u16,
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">pub </span>return_codes: Vec&lt;SubscribeReasonCode&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">pub fn </span>new(pkid: u16, return_codes: Vec&lt;SubscribeReasonCode&gt;) -&gt; SubAck {
<a href=#14 id=14 data-nosnippet>14</a> SubAck { pkid, return_codes }
<a href=#15 id=15 data-nosnippet>15</a> }
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#18 id=18 data-nosnippet>18</a> <span class="number">2 </span>+ <span class="self">self</span>.return_codes.len()
<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> <span class="number">1 </span>+ remaining_len_size + len
<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">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=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#29 id=29 data-nosnippet>29</a> bytes.advance(variable_header_index);
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">if </span>!bytes.has_remaining() {
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::MalformedPacket);
<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><span class="kw-2">mut </span>return_codes = Vec::new();
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#38 id=38 data-nosnippet>38</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=#39 id=39 data-nosnippet>39</a> return_codes.push(return_code.try_into()<span class="question-mark">?</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> <span class="kw">let </span>suback = SubAck { pkid, return_codes };
<a href=#43 id=43 data-nosnippet>43</a> <span class="prelude-val">Ok</span>(suback)
<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">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=#47 id=47 data-nosnippet>47</a> buffer.put_u8(<span class="number">0x90</span>);
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>p: Vec&lt;u8&gt; = <span class="self">self
<a href=#53 id=53 data-nosnippet>53</a> </span>.return_codes
<a href=#54 id=54 data-nosnippet>54</a> .iter()
<a href=#55 id=55 data-nosnippet>55</a> .map(|<span class="kw-2">&amp;</span>code| <span class="kw">match </span>code {
<a href=#56 id=56 data-nosnippet>56</a> SubscribeReasonCode::Success(qos) =&gt; qos <span class="kw">as </span>u8,
<a href=#57 id=57 data-nosnippet>57</a> SubscribeReasonCode::Failure =&gt; <span class="number">0x80</span>,
<a href=#58 id=58 data-nosnippet>58</a> })
<a href=#59 id=59 data-nosnippet>59</a> .collect();
<a href=#60 id=60 data-nosnippet>60</a> buffer.extend_from_slice(<span class="kw-2">&amp;</span>p);
<a href=#61 id=61 data-nosnippet>61</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_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>
<a href=#65 id=65 data-nosnippet>65</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
<a href=#66 id=66 data-nosnippet>66</a></span><span class="kw">pub enum </span>SubscribeReasonCode {
<a href=#67 id=67 data-nosnippet>67</a> Success(QoS),
<a href=#68 id=68 data-nosnippet>68</a> Failure,
<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><span class="kw">impl </span>TryFrom&lt;u8&gt; <span class="kw">for </span>SubscribeReasonCode {
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">type </span>Error = <span class="kw">super</span>::Error;
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</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=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>v = <span class="kw">match </span>value {
<a href=#76 id=76 data-nosnippet>76</a> <span class="number">0 </span>=&gt; SubscribeReasonCode::Success(QoS::AtMostOnce),
<a href=#77 id=77 data-nosnippet>77</a> <span class="number">1 </span>=&gt; SubscribeReasonCode::Success(QoS::AtLeastOnce),
<a href=#78 id=78 data-nosnippet>78</a> <span class="number">2 </span>=&gt; SubscribeReasonCode::Success(QoS::ExactlyOnce),
<a href=#79 id=79 data-nosnippet>79</a> <span class="number">128 </span>=&gt; SubscribeReasonCode::Failure,
<a href=#80 id=80 data-nosnippet>80</a> v =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">super</span>::Error::InvalidSubscribeReasonCode(v)),
<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="prelude-val">Ok</span>(v)
<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>
<a href=#87 id=87 data-nosnippet>87</a><span class="attr">#[cfg(test)]
<a href=#88 id=88 data-nosnippet>88</a></span><span class="kw">mod </span>test {
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a> <span class="attr">#[test]
<a href=#94 id=94 data-nosnippet>94</a> </span><span class="kw">fn </span>suback_parsing_works() {
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span>stream = <span class="macro">vec!</span>[
<a href=#96 id=96 data-nosnippet>96</a> <span class="number">0x90</span>, <span class="number">4</span>, <span class="comment">// packet type, flags and remaining len
<a href=#97 id=97 data-nosnippet>97</a> </span><span class="number">0x00</span>, <span class="number">0x0F</span>, <span class="comment">// variable header. pkid = 15
<a href=#98 id=98 data-nosnippet>98</a> </span><span class="number">0x01</span>, <span class="number">0x80</span>, <span class="comment">// payload. return codes [success qos1, failure]
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="number">0xDE</span>, <span class="number">0xAD</span>, <span class="number">0xBE</span>, <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#100 id=100 data-nosnippet>100</a> </span>];
<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>stream = BytesMut::from(<span class="kw-2">&amp;</span>stream[..]);
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>ack_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>packet = SubAck::read(fixed_header, ack_bytes).unwrap();
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="macro">assert_eq!</span>(
<a href=#108 id=108 data-nosnippet>108</a> packet,
<a href=#109 id=109 data-nosnippet>109</a> SubAck {
<a href=#110 id=110 data-nosnippet>110</a> pkid: <span class="number">15</span>,
<a href=#111 id=111 data-nosnippet>111</a> return_codes: <span class="macro">vec!</span>[
<a href=#112 id=112 data-nosnippet>112</a> SubscribeReasonCode::Success(QoS::AtLeastOnce),
<a href=#113 id=113 data-nosnippet>113</a> SubscribeReasonCode::Failure,
<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> }
<a href=#118 id=118 data-nosnippet>118</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,242 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</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, PartialEq, Eq)]
<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;SubscribeFilter&gt;,
<a href=#9 id=9 data-nosnippet>9</a>}
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">impl </span>Subscribe {
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;&gt;(path: S, qos: QoS) -&gt; Subscribe {
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">let </span>filter = SubscribeFilter {
<a href=#14 id=14 data-nosnippet>14</a> path: path.into(),
<a href=#15 id=15 data-nosnippet>15</a> qos,
<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> Subscribe {
<a href=#19 id=19 data-nosnippet>19</a> pkid: <span class="number">0</span>,
<a href=#20 id=20 data-nosnippet>20</a> filters: <span class="macro">vec!</span>[filter],
<a href=#21 id=21 data-nosnippet>21</a> }
<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> <span class="kw">pub fn </span>new_many&lt;T&gt;(topics: T) -&gt; Subscribe
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">where
<a href=#26 id=26 data-nosnippet>26</a> </span>T: IntoIterator&lt;Item = SubscribeFilter&gt;,
<a href=#27 id=27 data-nosnippet>27</a> {
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>filters: Vec&lt;SubscribeFilter&gt; = topics.into_iter().collect();
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a> Subscribe { pkid: <span class="number">0</span>, filters }
<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>add(<span class="kw-2">&amp;mut </span><span class="self">self</span>, path: String, qos: QoS) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>filter = SubscribeFilter { path, qos };
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="self">self</span>.filters.push(filter);
<a href=#37 id=37 data-nosnippet>37</a> <span class="self">self
<a href=#38 id=38 data-nosnippet>38</a> </span>}
<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="comment">// len of pkid + vec![subscribe filter len]
<a href=#42 id=42 data-nosnippet>42</a> </span><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=#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>size(<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>len = <span class="self">self</span>.len();
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a> <span class="number">1 </span>+ remaining_len_size + len
<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">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=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#54 id=54 data-nosnippet>54</a> bytes.advance(variable_header_index);
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a> <span class="comment">// variable header size = 2 (packet identifier)
<a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">let </span><span class="kw-2">mut </span>filters = Vec::new();
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">while </span>bytes.has_remaining() {
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span>path = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>options = read_u8(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>requested_qos = options &amp; <span class="number">0b0000_0011</span>;
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> filters.push(SubscribeFilter {
<a href=#67 id=67 data-nosnippet>67</a> path,
<a href=#68 id=68 data-nosnippet>68</a> qos: qos(requested_qos)<span class="question-mark">?</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>
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">match </span>filters.len() {
<a href=#73 id=73 data-nosnippet>73</a> <span class="number">0 </span>=&gt; <span class="prelude-val">Err</span>(Error::EmptySubscription),
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Ok</span>(Subscribe { pkid, filters }),
<a href=#75 id=75 data-nosnippet>75</a> }
<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="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=#79 id=79 data-nosnippet>79</a> <span class="comment">// write packet type
<a href=#80 id=80 data-nosnippet>80</a> </span>buffer.put_u8(<span class="number">0x82</span>);
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="comment">// write remaining length
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(buffer, remaining_len)<span class="question-mark">?</span>;
<a href=#85 id=85 data-nosnippet>85</a>
<a href=#86 id=86 data-nosnippet>86</a> <span class="comment">// write packet id
<a href=#87 id=87 data-nosnippet>87</a> </span>buffer.put_u16(<span class="self">self</span>.pkid);
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="comment">// write filters
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="kw">for </span>filter <span class="kw">in </span><span class="self">self</span>.filters.iter() {
<a href=#91 id=91 data-nosnippet>91</a> filter.write(buffer);
<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="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#95 id=95 data-nosnippet>95</a> }
<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="doccomment">/// Subscription filter
<a href=#99 id=99 data-nosnippet>99</a></span><span class="attr">#[derive(Clone, PartialEq, Eq)]
<a href=#100 id=100 data-nosnippet>100</a></span><span class="kw">pub struct </span>SubscribeFilter {
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">pub </span>path: String,
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">pub </span>qos: QoS,
<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><span class="kw">impl </span>SubscribeFilter {
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">pub fn </span>new(path: String, qos: QoS) -&gt; SubscribeFilter {
<a href=#107 id=107 data-nosnippet>107</a> SubscribeFilter { path, qos }
<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">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#111 id=111 data-nosnippet>111</a> <span class="comment">// filter len + filter + options
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="number">2 </span>+ <span class="self">self</span>.path.len() + <span class="number">1
<a href=#113 id=113 data-nosnippet>113</a> </span>}
<a href=#114 id=114 data-nosnippet>114</a>
<a href=#115 id=115 data-nosnippet>115</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) {
<a href=#116 id=116 data-nosnippet>116</a> <span class="kw">let </span><span class="kw-2">mut </span>options = <span class="number">0</span>;
<a href=#117 id=117 data-nosnippet>117</a> options |= <span class="self">self</span>.qos <span class="kw">as </span>u8;
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> write_mqtt_string(buffer, <span class="self">self</span>.path.as_str());
<a href=#120 id=120 data-nosnippet>120</a> buffer.put_u8(options);
<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="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#125 id=125 data-nosnippet>125</a></span><span class="kw">pub enum </span>RetainForwardRule {
<a href=#126 id=126 data-nosnippet>126</a> OnEverySubscribe,
<a href=#127 id=127 data-nosnippet>127</a> OnNewSubscribe,
<a href=#128 id=128 data-nosnippet>128</a> Never,
<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">impl </span>fmt::Debug <span class="kw">for </span>Subscribe {
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#133 id=133 data-nosnippet>133</a> <span class="macro">write!</span>(
<a href=#134 id=134 data-nosnippet>134</a> f,
<a href=#135 id=135 data-nosnippet>135</a> <span class="string">"Filters = {:?}, Packet id = {:?}"</span>,
<a href=#136 id=136 data-nosnippet>136</a> <span class="self">self</span>.filters, <span class="self">self</span>.pkid
<a href=#137 id=137 data-nosnippet>137</a> )
<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>
<a href=#141 id=141 data-nosnippet>141</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SubscribeFilter {
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#143 id=143 data-nosnippet>143</a> <span class="macro">write!</span>(f, <span class="string">"Filter = {}, Qos = {:?}"</span>, <span class="self">self</span>.path, <span class="self">self</span>.qos)
<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 class="attr">#[cfg(test)]
<a href=#148 id=148 data-nosnippet>148</a></span><span class="kw">mod </span>test {
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">use </span>bytes::BytesMut;
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">use </span>pretty_assertions::assert_eq;
<a href=#152 id=152 data-nosnippet>152</a>
<a href=#153 id=153 data-nosnippet>153</a> <span class="attr">#[test]
<a href=#154 id=154 data-nosnippet>154</a> </span><span class="kw">fn </span>subscribe_parsing_works() {
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">let </span>stream = <span class="kw-2">&amp;</span>[
<a href=#156 id=156 data-nosnippet>156</a> <span class="number">0b1000_0010</span>,
<a href=#157 id=157 data-nosnippet>157</a> <span class="number">20</span>, <span class="comment">// packet type, flags and remaining len
<a href=#158 id=158 data-nosnippet>158</a> </span><span class="number">0x01</span>,
<a href=#159 id=159 data-nosnippet>159</a> <span class="number">0x04</span>, <span class="comment">// variable header. pkid = 260
<a href=#160 id=160 data-nosnippet>160</a> </span><span class="number">0x00</span>,
<a href=#161 id=161 data-nosnippet>161</a> <span class="number">0x03</span>,
<a href=#162 id=162 data-nosnippet>162</a> <span class="string">b'a'</span>,
<a href=#163 id=163 data-nosnippet>163</a> <span class="string">b'/'</span>,
<a href=#164 id=164 data-nosnippet>164</a> <span class="string">b'+'</span>, <span class="comment">// payload. topic filter = 'a/+'
<a href=#165 id=165 data-nosnippet>165</a> </span><span class="number">0x00</span>, <span class="comment">// payload. qos = 0
<a href=#166 id=166 data-nosnippet>166</a> </span><span class="number">0x00</span>,
<a href=#167 id=167 data-nosnippet>167</a> <span class="number">0x01</span>,
<a href=#168 id=168 data-nosnippet>168</a> <span class="string">b'#'</span>, <span class="comment">// payload. topic filter = '#'
<a href=#169 id=169 data-nosnippet>169</a> </span><span class="number">0x01</span>, <span class="comment">// payload. qos = 1
<a href=#170 id=170 data-nosnippet>170</a> </span><span class="number">0x00</span>,
<a href=#171 id=171 data-nosnippet>171</a> <span class="number">0x05</span>,
<a href=#172 id=172 data-nosnippet>172</a> <span class="string">b'a'</span>,
<a href=#173 id=173 data-nosnippet>173</a> <span class="string">b'/'</span>,
<a href=#174 id=174 data-nosnippet>174</a> <span class="string">b'b'</span>,
<a href=#175 id=175 data-nosnippet>175</a> <span class="string">b'/'</span>,
<a href=#176 id=176 data-nosnippet>176</a> <span class="string">b'c'</span>, <span class="comment">// payload. topic filter = 'a/b/c'
<a href=#177 id=177 data-nosnippet>177</a> </span><span class="number">0x02</span>, <span class="comment">// payload. qos = 2
<a href=#178 id=178 data-nosnippet>178</a> </span><span class="number">0xDE</span>,
<a href=#179 id=179 data-nosnippet>179</a> <span class="number">0xAD</span>,
<a href=#180 id=180 data-nosnippet>180</a> <span class="number">0xBE</span>,
<a href=#181 id=181 data-nosnippet>181</a> <span class="number">0xEF</span>, <span class="comment">// extra packets in the stream
<a href=#182 id=182 data-nosnippet>182</a> </span>];
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span><span class="kw-2">mut </span>stream = BytesMut::from(<span class="kw-2">&amp;</span>stream[..]);
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">let </span>fixed_header = parse_fixed_header(stream.iter()).unwrap();
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">let </span>subscribe_bytes = stream.split_to(fixed_header.frame_length()).freeze();
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">let </span>packet = Subscribe::read(fixed_header, subscribe_bytes).unwrap();
<a href=#187 id=187 data-nosnippet>187</a>
<a href=#188 id=188 data-nosnippet>188</a> <span class="macro">assert_eq!</span>(
<a href=#189 id=189 data-nosnippet>189</a> packet,
<a href=#190 id=190 data-nosnippet>190</a> Subscribe {
<a href=#191 id=191 data-nosnippet>191</a> pkid: <span class="number">260</span>,
<a href=#192 id=192 data-nosnippet>192</a> filters: <span class="macro">vec!</span>[
<a href=#193 id=193 data-nosnippet>193</a> SubscribeFilter::new(<span class="string">"a/+"</span>.to_owned(), QoS::AtMostOnce),
<a href=#194 id=194 data-nosnippet>194</a> SubscribeFilter::new(<span class="string">"#"</span>.to_owned(), QoS::AtLeastOnce),
<a href=#195 id=195 data-nosnippet>195</a> SubscribeFilter::new(<span class="string">"a/b/c"</span>.to_owned(), QoS::ExactlyOnce)
<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> );
<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="attr">#[test]
<a href=#202 id=202 data-nosnippet>202</a> </span><span class="kw">fn </span>subscribe_encoding_works() {
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">let </span>subscribe = Subscribe {
<a href=#204 id=204 data-nosnippet>204</a> pkid: <span class="number">260</span>,
<a href=#205 id=205 data-nosnippet>205</a> filters: <span class="macro">vec!</span>[
<a href=#206 id=206 data-nosnippet>206</a> SubscribeFilter::new(<span class="string">"a/+"</span>.to_owned(), QoS::AtMostOnce),
<a href=#207 id=207 data-nosnippet>207</a> SubscribeFilter::new(<span class="string">"#"</span>.to_owned(), QoS::AtLeastOnce),
<a href=#208 id=208 data-nosnippet>208</a> SubscribeFilter::new(<span class="string">"a/b/c"</span>.to_owned(), QoS::ExactlyOnce),
<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="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new();
<a href=#213 id=213 data-nosnippet>213</a> subscribe.write(<span class="kw-2">&amp;mut </span>buf).unwrap();
<a href=#214 id=214 data-nosnippet>214</a> <span class="macro">assert_eq!</span>(
<a href=#215 id=215 data-nosnippet>215</a> buf,
<a href=#216 id=216 data-nosnippet>216</a> <span class="macro">vec!</span>[
<a href=#217 id=217 data-nosnippet>217</a> <span class="number">0b1000_0010</span>,
<a href=#218 id=218 data-nosnippet>218</a> <span class="number">20</span>,
<a href=#219 id=219 data-nosnippet>219</a> <span class="number">0x01</span>,
<a href=#220 id=220 data-nosnippet>220</a> <span class="number">0x04</span>, <span class="comment">// pkid = 260
<a href=#221 id=221 data-nosnippet>221</a> </span><span class="number">0x00</span>,
<a href=#222 id=222 data-nosnippet>222</a> <span class="number">0x03</span>,
<a href=#223 id=223 data-nosnippet>223</a> <span class="string">b'a'</span>,
<a href=#224 id=224 data-nosnippet>224</a> <span class="string">b'/'</span>,
<a href=#225 id=225 data-nosnippet>225</a> <span class="string">b'+'</span>, <span class="comment">// topic filter = 'a/+'
<a href=#226 id=226 data-nosnippet>226</a> </span><span class="number">0x00</span>, <span class="comment">// qos = 0
<a href=#227 id=227 data-nosnippet>227</a> </span><span class="number">0x00</span>,
<a href=#228 id=228 data-nosnippet>228</a> <span class="number">0x01</span>,
<a href=#229 id=229 data-nosnippet>229</a> <span class="string">b'#'</span>, <span class="comment">// topic filter = '#'
<a href=#230 id=230 data-nosnippet>230</a> </span><span class="number">0x01</span>, <span class="comment">// qos = 1
<a href=#231 id=231 data-nosnippet>231</a> </span><span class="number">0x00</span>,
<a href=#232 id=232 data-nosnippet>232</a> <span class="number">0x05</span>,
<a href=#233 id=233 data-nosnippet>233</a> <span class="string">b'a'</span>,
<a href=#234 id=234 data-nosnippet>234</a> <span class="string">b'/'</span>,
<a href=#235 id=235 data-nosnippet>235</a> <span class="string">b'b'</span>,
<a href=#236 id=236 data-nosnippet>236</a> <span class="string">b'/'</span>,
<a href=#237 id=237 data-nosnippet>237</a> <span class="string">b'c'</span>, <span class="comment">// topic filter = 'a/b/c'
<a href=#238 id=238 data-nosnippet>238</a> </span><span class="number">0x02 </span><span class="comment">// qos = 2
<a href=#239 id=239 data-nosnippet>239</a> </span>]
<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>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,38 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>unsuback.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 </span>bytes::{Buf, BufMut, Bytes, BytesMut};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span><span class="kw">crate</span>::mqttbytes::{read_u16, Error, FixedHeader};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// Acknowledgement to unsubscribe
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub struct </span>UnsubAck {
<a href=#8 id=8 data-nosnippet>8</a> <span class="kw">pub </span>pkid: u16,
<a href=#9 id=9 data-nosnippet>9</a>}
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">impl </span>UnsubAck {
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub fn </span>new(pkid: u16) -&gt; UnsubAck {
<a href=#13 id=13 data-nosnippet>13</a> UnsubAck { pkid }
<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">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#17 id=17 data-nosnippet>17</a> <span class="number">4
<a href=#18 id=18 data-nosnippet>18</a> </span>}
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</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=#21 id=21 data-nosnippet>21</a> <span class="kw">if </span>fixed_header.remaining_len != <span class="number">2 </span>{
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">return </span><span class="prelude-val">Err</span>(Error::PayloadSizeIncorrect);
<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="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#26 id=26 data-nosnippet>26</a> bytes.advance(variable_header_index);
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>pkid = read_u16(<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">let </span>unsuback = UnsubAck { pkid };
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a> <span class="prelude-val">Ok</span>(unsuback)
<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>write(<span class="kw-2">&amp;</span><span class="self">self</span>, payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#34 id=34 data-nosnippet>34</a> payload.put_slice(<span class="kw-2">&amp;</span>[<span class="number">0xB0</span>, <span class="number">0x02</span>]);
<a href=#35 id=35 data-nosnippet>35</a> payload.put_u16(<span class="self">self</span>.pkid);
<a href=#36 id=36 data-nosnippet>36</a> <span class="prelude-val">Ok</span>(<span class="number">4</span>)
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>}</code></pre></div></section></main></body></html>
@@ -0,0 +1,61 @@
<!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/mqttbytes/v4/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/mqttbytes/v4/</div>unsubscribe.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::{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)]
<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>topics: Vec&lt;String&gt;,
<a href=#9 id=9 data-nosnippet>9</a>}
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">impl </span>Unsubscribe {
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">pub fn </span>new&lt;S: Into&lt;String&gt;&gt;(topic: S) -&gt; Unsubscribe {
<a href=#13 id=13 data-nosnippet>13</a> Unsubscribe {
<a href=#14 id=14 data-nosnippet>14</a> pkid: <span class="number">0</span>,
<a href=#15 id=15 data-nosnippet>15</a> topics: <span class="macro">vec!</span>[topic.into()],
<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>
<a href=#19 id=19 data-nosnippet>19</a> <span class="kw">fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#20 id=20 data-nosnippet>20</a> <span class="comment">// len of pkid + vec![subscribe topics len]
<a href=#21 id=21 data-nosnippet>21</a> </span><span class="number">2 </span>+ <span class="self">self</span>.topics.iter().fold(<span class="number">0</span>, |s, t| s + t.len() + <span class="number">2</span>)
<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> <span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span>len = <span class="self">self</span>.len();
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">let </span>remaining_len_size = len_len(len);
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a> <span class="number">1 </span>+ remaining_len_size + len
<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> <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=#32 id=32 data-nosnippet>32</a> <span class="kw">let </span>variable_header_index = fixed_header.fixed_header_len;
<a href=#33 id=33 data-nosnippet>33</a> bytes.advance(variable_header_index);
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span>pkid = read_u16(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span><span class="kw-2">mut </span>payload_bytes = fixed_header.remaining_len - <span class="number">2</span>;
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span><span class="kw-2">mut </span>topics = Vec::with_capacity(<span class="number">1</span>);
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">while </span>payload_bytes &gt; <span class="number">0 </span>{
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>topic_filter = read_mqtt_string(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<a href=#41 id=41 data-nosnippet>41</a> payload_bytes -= topic_filter.len() + <span class="number">2</span>;
<a href=#42 id=42 data-nosnippet>42</a> topics.push(topic_filter);
<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">let </span>unsubscribe = Unsubscribe { pkid, topics };
<a href=#46 id=46 data-nosnippet>46</a> <span class="prelude-val">Ok</span>(unsubscribe)
<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">pub fn </span>write(<span class="kw-2">&amp;</span><span class="self">self</span>, payload: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;usize, Error&gt; {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>remaining_len = <span class="self">self</span>.len();
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> payload.put_u8(<span class="number">0xA2</span>);
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>remaining_len_bytes = write_remaining_length(payload, remaining_len)<span class="question-mark">?</span>;
<a href=#54 id=54 data-nosnippet>54</a> payload.put_u16(<span class="self">self</span>.pkid);
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">for </span>topic <span class="kw">in </span><span class="self">self</span>.topics.iter() {
<a href=#57 id=57 data-nosnippet>57</a> write_mqtt_string(payload, topic.as_str());
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a> <span class="prelude-val">Ok</span>(<span class="number">1 </span>+ remaining_len_bytes + remaining_len)
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>}</code></pre></div></section></main></body></html>