| <!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 `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/void-1.0.2/src/lib.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>lib.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> |
| </pre><pre class="rust "> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">test</span>, <span class="ident">deny</span>(<span class="ident">warnings</span>))]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">deny</span>(<span class="ident">missing_docs</span>)]</span> |
| <span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std"</span>), <span class="ident">no_std</span>)]</span> |
| |
| <span class="doccomment">//! # Void</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! The uninhabited void type for use in statically impossible cases.</span> |
| <span class="doccomment">//!</span> |
| <span class="doccomment">//! In its own crate so all the users in the ecosystem can share the same type.</span> |
| <span class="doccomment">//! This crate also comes ready with several extension traits for Result that add</span> |
| <span class="doccomment">//! extra functionality to `Result<T, Void>` and `Result<Void, E>`.</span> |
| <span class="doccomment">//!</span> |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std"</span>))]</span> |
| <span class="kw">mod</span> <span class="ident">coreprovider</span> { |
| <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">core</span>; |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">fmt</span>, <span class="ident">cmp</span>}; |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std"</span>)]</span> |
| <span class="kw">mod</span> <span class="ident">coreprovider</span> { |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">fmt</span>, <span class="ident">cmp</span>, <span class="ident">error</span>}; |
| } |
| |
| <span class="kw">use</span> <span class="ident">coreprovider</span>::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// The empty type for cases which can't occur.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Void</span> { } |
| |
| <span class="kw">impl</span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">Void</span> { |
| <span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Void</span> { |
| <span class="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Void</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</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="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Void</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</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="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">cmp</span>::<span class="ident">PartialEq</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Void</span> { |
| <span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, _: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="ident">bool</span> { |
| <span class="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">cmp</span>::<span class="ident">PartialOrd</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Void</span> { |
| <span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, _: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">cmp</span>::<span class="ident">Ordering</span><span class="op">></span> { |
| <span class="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std"</span>)]</span> |
| <span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">Void</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="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</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="ident">unreachable</span>(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| } |
| |
| <span class="doccomment">/// A safe version of `intrinsincs::unreachable`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this typechecks, anything that causes this to run is unreachable code.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Calling this function in reachable code invokes undefined behavior, but</span> |
| <span class="doccomment">/// should not be possible unless `unsafe` was used elsewhere to construct</span> |
| <span class="doccomment">/// an instance of `Void` (which is already undefined behavior).</span> |
| <span class="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unreachable</span>(<span class="ident">x</span>: <span class="ident">Void</span>) <span class="op">-></span> <span class="op">!</span> { |
| <span class="kw">match</span> <span class="ident">x</span> {} |
| } |
| |
| <span class="doccomment">/// Extensions to `Result<T, Void>`</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">ResultVoidExt</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>: <span class="ident">Sized</span> { |
| <span class="doccomment">/// Get the value out of a wrapper.</span> |
| <span class="kw">fn</span> <span class="ident">void_unwrap</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">T</span>; |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">ResultVoidExt</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Void</span><span class="op">></span> { |
| <span class="doccomment">/// Get the value out of an always-ok Result.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Never panics, since it is statically known to be Ok.</span> |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="ident">void_unwrap</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="kw">match</span> <span class="self">self</span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">val</span>) <span class="op">=></span> <span class="ident">val</span>, |
| <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> <span class="ident">unreachable</span>(<span class="ident">e</span>) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Extensions to `Result<Void, E>`</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">ResultVoidErrExt</span><span class="op"><</span><span class="ident">E</span><span class="op">></span>: <span class="ident">Sized</span> { |
| <span class="doccomment">/// Get the error out of a wrapper.</span> |
| <span class="kw">fn</span> <span class="ident">void_unwrap_err</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">E</span>; |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> <span class="ident">ResultVoidErrExt</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> <span class="kw">for</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Void</span>, <span class="ident">E</span><span class="op">></span> { |
| <span class="doccomment">/// Get the error out of an always-err Result.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Never panics, since it is statically known to be Err.</span> |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="ident">void_unwrap_err</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">E</span> { |
| <span class="kw">match</span> <span class="self">self</span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">v</span>) <span class="op">=></span> <span class="ident">unreachable</span>(<span class="ident">v</span>), |
| <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> <span class="ident">e</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 = "void"; |
| </script> |
| <script src="../../main.js"></script> |
| <script defer src="../../search-index.js"></script> |
| </body> |
| </html> |