| <!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 to the Rust file `src/errors.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>errors.rs.html -- source</title> |
| |
| <link rel="stylesheet" type="text/css" href="../../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> |
| <link rel="stylesheet" type="text/css" href="../../main.css"> |
| |
| |
| |
| |
| </head> |
| <body class="rustdoc source"> |
| <!--[if lte IE 8]> |
| <div class="warning"> |
| This old browser is unsupported and will most likely display funky |
| things. |
| </div> |
| <![endif]--> |
| |
| |
| |
| <nav class="sidebar"> |
| |
| |
| </nav> |
| |
| <nav class="sub"> |
| <form class="search-form js-only"> |
| <div class="search-container"> |
| <input class="search-input" name="search" |
| autocomplete="off" |
| placeholder="Click or press ‘S’ to search, ‘?’ for more options…" |
| type="search"> |
| </div> |
| </form> |
| </nav> |
| |
| <section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span> |
| <span id="2"> 2</span> |
| <span id="3"> 3</span> |
| <span id="4"> 4</span> |
| <span id="5"> 5</span> |
| <span id="6"> 6</span> |
| <span id="7"> 7</span> |
| <span id="8"> 8</span> |
| <span id="9"> 9</span> |
| <span id="10"> 10</span> |
| <span id="11"> 11</span> |
| <span id="12"> 12</span> |
| <span id="13"> 13</span> |
| <span id="14"> 14</span> |
| <span id="15"> 15</span> |
| <span id="16"> 16</span> |
| <span id="17"> 17</span> |
| <span id="18"> 18</span> |
| <span id="19"> 19</span> |
| <span id="20"> 20</span> |
| <span id="21"> 21</span> |
| <span id="22"> 22</span> |
| <span id="23"> 23</span> |
| <span id="24"> 24</span> |
| <span id="25"> 25</span> |
| <span id="26"> 26</span> |
| <span id="27"> 27</span> |
| <span id="28"> 28</span> |
| <span id="29"> 29</span> |
| <span id="30"> 30</span> |
| <span id="31"> 31</span> |
| <span id="32"> 32</span> |
| <span id="33"> 33</span> |
| <span id="34"> 34</span> |
| <span id="35"> 35</span> |
| <span id="36"> 36</span> |
| <span id="37"> 37</span> |
| <span id="38"> 38</span> |
| <span id="39"> 39</span> |
| <span id="40"> 40</span> |
| <span id="41"> 41</span> |
| <span id="42"> 42</span> |
| <span id="43"> 43</span> |
| <span id="44"> 44</span> |
| <span id="45"> 45</span> |
| <span id="46"> 46</span> |
| <span id="47"> 47</span> |
| <span id="48"> 48</span> |
| <span id="49"> 49</span> |
| <span id="50"> 50</span> |
| <span id="51"> 51</span> |
| <span id="52"> 52</span> |
| <span id="53"> 53</span> |
| <span id="54"> 54</span> |
| <span id="55"> 55</span> |
| <span id="56"> 56</span> |
| <span id="57"> 57</span> |
| <span id="58"> 58</span> |
| <span id="59"> 59</span> |
| <span id="60"> 60</span> |
| <span id="61"> 61</span> |
| <span id="62"> 62</span> |
| <span id="63"> 63</span> |
| <span id="64"> 64</span> |
| <span id="65"> 65</span> |
| <span id="66"> 66</span> |
| <span id="67"> 67</span> |
| <span id="68"> 68</span> |
| <span id="69"> 69</span> |
| <span id="70"> 70</span> |
| <span id="71"> 71</span> |
| <span id="72"> 72</span> |
| <span id="73"> 73</span> |
| <span id="74"> 74</span> |
| <span id="75"> 75</span> |
| <span id="76"> 76</span> |
| <span id="77"> 77</span> |
| <span id="78"> 78</span> |
| <span id="79"> 79</span> |
| <span id="80"> 80</span> |
| <span id="81"> 81</span> |
| <span id="82"> 82</span> |
| <span id="83"> 83</span> |
| <span id="84"> 84</span> |
| <span id="85"> 85</span> |
| <span id="86"> 86</span> |
| <span id="87"> 87</span> |
| <span id="88"> 88</span> |
| <span id="89"> 89</span> |
| <span id="90"> 90</span> |
| <span id="91"> 91</span> |
| <span id="92"> 92</span> |
| <span id="93"> 93</span> |
| <span id="94"> 94</span> |
| <span id="95"> 95</span> |
| <span id="96"> 96</span> |
| <span id="97"> 97</span> |
| <span id="98"> 98</span> |
| <span id="99"> 99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| </pre><pre class="rust "> |
| <span class="comment">// errors.rs</span> |
| <span class="comment">// This file is part of the Eclipse Paho MQTT Rust Client library.</span> |
| <span class="comment">//</span> |
| |
| <span class="comment">/******************************************************************************* |
| * Copyright (c) 2017 Frank Pagliughi <fpagliughi@mindspring.com> |
| * |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * and Eclipse Distribution License v1.0 which accompany this distribution. |
| * |
| * The Eclipse Public License is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * and the Eclipse Distribution License is available at |
| * http://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * Contributors: |
| * Frank Pagliughi - initial implementation and documentation |
| *******************************************************************************/</span> |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::{<span class="comment">/*from_utf8,*/</span> <span class="ident">Utf8Error</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">convert</span>::<span class="ident">From</span>; |
| |
| <span class="doccomment">/// The possible errors</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ErrorKind</span> { |
| <span class="doccomment">/// Bad QoS value</span> |
| <span class="ident">QosError</span>, |
| <span class="doccomment">/// Operation failed because of a type mismatch.</span> |
| <span class="ident">TypeError</span>, |
| <span class="doccomment">/// Persistence Error</span> |
| <span class="ident">PersistenceError</span>, |
| <span class="doccomment">/// General Failure (TODO: Something better than this)</span> |
| <span class="ident">General</span>, |
| <span class="doccomment">/// I/O Error</span> |
| <span class="ident">IoError</span>, |
| } |
| |
| <span class="doccomment">/// An MQTT Error</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">MqttError</span> { |
| <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>, |
| } |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span> |
| <span class="kw">enum</span> <span class="ident">ErrorRepr</span> { |
| <span class="ident">WithDescription</span>(<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>), |
| <span class="ident">WithDescriptionAndDetail</span>(<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">String</span>), |
| <span class="ident">IoError</span>(<span class="ident">io</span>::<span class="ident">Error</span>), |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">io</span>::<span class="ident">Error</span>) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">IoError</span>(<span class="ident">err</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Utf8Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(_: <span class="ident">Utf8Error</span>) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(<span class="ident">ErrorKind</span>::<span class="ident">TypeError</span>, <span class="op">-</span><span class="number">1</span>, <span class="string">"Invalid UTF-8"</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span>(<span class="ident">ErrorKind</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>((<span class="ident">kind</span>, <span class="ident">desc</span>): (<span class="ident">ErrorKind</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>)) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(<span class="ident">kind</span>, <span class="op">-</span><span class="number">1</span>, <span class="ident">desc</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span>(<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>((<span class="ident">kind</span>, <span class="ident">err</span>, <span class="ident">desc</span>): (<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>)) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(<span class="ident">kind</span>, <span class="ident">err</span>, <span class="ident">desc</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span>(<span class="ident">ErrorKind</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">String</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>((<span class="ident">kind</span>, <span class="ident">desc</span>, <span class="ident">detail</span>): (<span class="ident">ErrorKind</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">String</span>)) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescriptionAndDetail</span>(<span class="ident">kind</span>, <span class="op">-</span><span class="number">1</span>, <span class="ident">desc</span>, <span class="ident">detail</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span>(<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">String</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>((<span class="ident">kind</span>, <span class="ident">err</span>, <span class="ident">desc</span>, <span class="ident">detail</span>): (<span class="ident">ErrorKind</span>, <span class="ident">i32</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>, <span class="ident">String</span>)) <span class="op">-></span> <span class="ident">MqttError</span> { |
| <span class="ident">MqttError</span> { <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescriptionAndDetail</span>(<span class="ident">kind</span>, <span class="ident">err</span>, <span class="ident">desc</span>, <span class="ident">detail</span>) } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> { |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">repr</span> { |
| <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(_, _, <span class="ident">desc</span>) <span class="op">=></span> <span class="ident">desc</span>, |
| <span class="ident">ErrorRepr</span>::<span class="ident">WithDescriptionAndDetail</span>(_, _, <span class="ident">desc</span>, _) <span class="op">=></span> <span class="ident">desc</span>, |
| <span class="ident">ErrorRepr</span>::<span class="ident">IoError</span>(<span class="kw-2">ref</span> <span class="ident">err</span>) <span class="op">=></span> <span class="ident">err</span>.<span class="ident">description</span>(), |
| } |
| } |
| |
| <span class="kw">fn</span> <span class="ident">cause</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">error</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">repr</span> { |
| <span class="ident">ErrorRepr</span>::<span class="ident">IoError</span>(<span class="kw-2">ref</span> <span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Some</span>(<span class="ident">err</span> <span class="kw">as</span> <span class="kw-2">&</span><span class="ident">error</span>::<span class="ident">Error</span>), |
| _ <span class="op">=></span> <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">fmt</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="self">self</span>.<span class="ident">repr</span> { |
| <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(_, <span class="ident">_err</span>, <span class="ident">desc</span>) <span class="op">=></span> <span class="ident">desc</span>.<span class="ident">fmt</span>(<span class="ident">f</span>), |
| <span class="ident">ErrorRepr</span>::<span class="ident">WithDescriptionAndDetail</span>(_, <span class="ident">_err</span>, <span class="ident">desc</span>, <span class="kw-2">ref</span> <span class="ident">detail</span>) <span class="op">=></span> { |
| <span class="ident">desc</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)<span class="question-mark">?</span>; |
| <span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">": "</span>)<span class="question-mark">?</span>; |
| <span class="ident">detail</span>.<span class="ident">fmt</span>(<span class="ident">f</span>) |
| } |
| <span class="ident">ErrorRepr</span>::<span class="ident">IoError</span>(<span class="kw-2">ref</span> <span class="ident">err</span>) <span class="op">=></span> <span class="ident">err</span>.<span class="ident">fmt</span>(<span class="ident">f</span>), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">MqttError</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">fmt</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="ident">fmt</span>::<span class="ident">Display</span>::<span class="ident">fmt</span>(<span class="self">self</span>, <span class="ident">f</span>) |
| } |
| } |
| |
| <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">PERSISTENCE_ERROR</span>: <span class="ident">MqttError</span> <span class="op">=</span> <span class="ident">MqttError</span> { |
| <span class="ident">repr</span>: <span class="ident">ErrorRepr</span>::<span class="ident">WithDescription</span>(<span class="ident">ErrorKind</span>::<span class="ident">PersistenceError</span>, <span class="op">-</span><span class="number">2</span>, <span class="string">"Persistence Error"</span>), |
| }; |
| |
| <span class="doccomment">/// Generic result for the entire public API</span> |
| <span class="kw">pub</span> <span class="kw">type</span> <span class="ident">MqttResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">MqttError</span><span class="op">></span>; |
| |
| |
| </pre> |
| </section> |
| <section id='search' class="content hidden"></section> |
| |
| <section class="footer"></section> |
| |
| <aside id="help" class="hidden"> |
| <div> |
| <h1 class="hidden">Help</h1> |
| |
| <div class="shortcuts"> |
| <h2>Keyboard Shortcuts</h2> |
| |
| <dl> |
| <dt>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</dt> |
| <dd>Go to active search result</dd> |
| <dt>+</dt> |
| <dd>Collapse/expand all sections</dd> |
| </dl> |
| </div> |
| |
| <div class="infos"> |
| <h2>Search Tricks</h2> |
| |
| <p> |
| Prefix searches with a type followed by a colon (e.g. |
| <code>fn:</code>) to restrict the search to a given type. |
| </p> |
| |
| <p> |
| Accepted types are: <code>fn</code>, <code>mod</code>, |
| <code>struct</code>, <code>enum</code>, |
| <code>trait</code>, <code>type</code>, <code>macro</code>, |
| and <code>const</code>. |
| </p> |
| |
| <p> |
| Search functions by type signature (e.g. |
| <code>vec -> usize</code> or <code>* -> vec</code>) |
| </p> |
| </div> |
| </div> |
| </aside> |
| |
| |
| |
| <script> |
| window.rootPath = "../../"; |
| window.currentCrate = "paho_mqtt"; |
| </script> |
| <script src="../../main.js"></script> |
| <script defer src="../../search-index.js"></script> |
| </body> |
| </html> |