<!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\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">
<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 source"><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>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
</pre><pre class='rust '>
<span class='doccomment'>//! Macrohelper</span>
<span class='doccomment'>//!</span>
<span class='doccomment'>//! This crate's goal of this crate is to make you not want to tear your hair out when working with</span>
<span class='doccomment'>//! `syn` crate for Macro's1.1</span>
<span class='doccomment'>//!</span>
<span class='doccomment'>//! Some core enums from `syn` are re-exported that represent core types</span>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>proc_macro</span>, <span class='ident'>proc_macro_lib</span>)]</span>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>proc_macro</span>;
<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>proc_macro</span>::<span class='ident'>TokenStream</span>;
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>syn</span>;
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>unused_imports</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>syn</span>::{
<span class='ident'>Lit</span>,
<span class='ident'>StrStyle</span>,
<span class='ident'>IntTy</span>,
<span class='ident'>FloatTy</span>,
<span class='ident'>Ty</span>,
<span class='ident'>Lifetime</span>,
<span class='ident'>ConstExpr</span>
};
<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>meta</span>;
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>unused_imports</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>meta</span>::<span class='ident'>HashTag</span>;
<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>bodykind</span>;
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>unused_imports</span>)]</span>
<span class='kw'>use</span> <span class='ident'>bodykind</span>::{
<span class='ident'>BodyKind</span>,
<span class='ident'>Enumerator</span>,
<span class='ident'>Variant</span>,
<span class='ident'>Field</span>,
<span class='ident'>Fields</span>,
<span class='ident'>Structure</span>
};
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>is_thing</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>name</span>:<span class='ident'>ident</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ma</span>: <span class='ident'>pat</span>) <span class='op'>=></span> {
<span class='attribute'>#[<span class='ident'>inline</span>(<span class='ident'>always</span>)]</span>
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>dead_code</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>name</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> {
<span class='kw'>match</span> <span class='self'>self</span> {
<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>ma</span> <span class='op'>=></span> <span class='bool-val'>true</span>,
_ <span class='op'>=></span> <span class='bool-val'>false</span>
}
}
}
}
<span class='doccomment'>/// Input to a macro1.1 invocation</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Macro1.1 compiler hook gives a string of tokens. That is converted to an AST by `syn`.</span>
<span class='doccomment'>/// This crate then converts `syn`'s output into this type.</span>
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>,<span class='ident'>Debug</span>)]</span>
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>dead_code</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>MacroInput</span> {
<span class='doccomment'>/// Information about any and all `#[...]` headers</span>
<span class='kw'>pub</span> <span class='ident'>attr</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>HashTag</span><span class='op'>></span>,
<span class='doccomment'>/// Name of the structure or enum</span>
<span class='kw'>pub</span> <span class='ident'>id</span>: <span class='ident'>String</span>,
<span class='doccomment'>/// Informatin about the body</span>
<span class='kw'>pub</span> <span class='ident'>body</span>: <span class='ident'>BodyKind</span>
}
<span class='kw'>impl</span> <span class='ident'>MacroInput</span> {
<span class='doccomment'>/// High level fake implemenation.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Just converts `TokenStream` to a string, and called `from_str`</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>from_tree</span>(<span class='ident'>input</span>: <span class='ident'>TokenStream</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>MacroInput</span>,<span class='ident'>String</span><span class='op'>></span> {
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>input</span>.<span class='ident'>to_string</span>();
<span class='ident'>MacroInput</span>::<span class='ident'>from_str</span>(<span class='kw-2'>&</span><span class='ident'>s</span>)
}
<span class='doccomment'>/// Actual implementation of the conversion</span>
<span class='attribute'>#[<span class='ident'>inline</span>]</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>from_str</span>(<span class='ident'>s</span>: <span class='kw-2'>&</span><span class='ident'>str</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>MacroInput</span>,<span class='ident'>String</span><span class='op'>></span> {
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>mem</span>;
<span class='comment'>//parse the input</span>
<span class='kw'>let</span> <span class='ident'>ast</span> <span class='op'>=</span> <span class='ident'>syn</span>::<span class='ident'>parse_macro_input</span>(<span class='ident'>s</span>)<span class='question-mark'>?</span>;
<span class='comment'>//build the return value</span>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>ret_val</span>: <span class='ident'>MacroInput</span> <span class='op'>=</span> <span class='kw'>unsafe</span>{ <span class='ident'>mem</span>::<span class='ident'>uninitialized</span>() };
<span class='ident'>ret_val</span>.<span class='ident'>id</span> <span class='op'>=</span> <span class='ident'>ast</span>.<span class='ident'>ident</span>.<span class='ident'>to_string</span>();
<span class='ident'>ret_val</span>.<span class='ident'>attr</span> <span class='op'>=</span> <span class='ident'>HashTag</span>::<span class='ident'>complete</span>( <span class='kw-2'>&</span><span class='ident'>ast</span>.<span class='ident'>attrs</span>);
<span class='comment'>//return value</span>
<span class='prelude-val'>Ok</span>(<span class='ident'>ret_val</span>)
}
}
<span class='doccomment'>/// Derive traits for tests</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Even tho `syn` has `PartialEq` and `Eq` derived for most types I'm getting massive</span>
<span class='doccomment'>///</span>
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>,<span class='ident'>Debug</span>,<span class='ident'>PartialEq</span>,<span class='ident'>Eq</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>FromLiteral</span> {
<span class='ident'>Str</span>(<span class='ident'>String</span>),
<span class='ident'>ByteStr</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>u8</span><span class='op'>></span>),
<span class='ident'>Byte</span>(<span class='ident'>u8</span>),
<span class='ident'>Int</span>(<span class='ident'>u64</span>),
<span class='ident'>Float</span>(<span class='ident'>String</span>),
<span class='ident'>Bool</span>(<span class='ident'>bool</span>),
<span class='ident'>Char</span>(<span class='ident'>char</span>)
}
<span class='kw'>impl</span> <span class='ident'>From</span><span class='op'><</span><span class='ident'>Lit</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>FromLiteral</span> {
<span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>x</span>: <span class='ident'>Lit</span>) <span class='op'>-></span> <span class='ident'>FromLiteral</span> {
<span class='kw'>match</span> <span class='ident'>x</span> {
<span class='ident'>Lit</span>::<span class='ident'>Str</span>(<span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Str</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>ByteStr</span>(<span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>ByteStr</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>Byte</span>(<span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Byte</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>Int</span>(<span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Int</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>Char</span>(<span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Char</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>Bool</span>(<span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Bool</span>(<span class='ident'>w</span>),
<span class='ident'>Lit</span>::<span class='ident'>Float</span>(<span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Float</span>(<span class='ident'>w</span>)
}
}
}
<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> <span class='ident'>From</span><span class='op'><</span><span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Lit</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>FromLiteral</span> {
<span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>x</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Lit</span>) <span class='op'>-></span> <span class='ident'>FromLiteral</span> {
<span class='kw'>match</span> <span class='ident'>x</span> {
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Str</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Str</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>ByteStr</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>ByteStr</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Byte</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Byte</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Int</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Int</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Char</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Char</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Bool</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Bool</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>()),
<span class='kw-2'>&</span><span class='ident'>Lit</span>::<span class='ident'>Float</span>(<span class='kw-2'>ref</span> <span class='ident'>w</span>,_) <span class='op'>=></span> <span class='ident'>FromLiteral</span>::<span class='ident'>Float</span>(<span class='ident'>w</span>.<span class='ident'>clone</span>())
}
}
}
<span class='kw'>impl</span> <span class='ident'>FromLiteral</span> {
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_str</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Str</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_bytestr</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>ByteStr</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_byte</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Byte</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_int</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Int</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_float</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Float</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_bool</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Bool</span>(_));
<span class='macro'>is_thing</span><span class='macro'>!</span>(<span class='ident'>is_char</span>,<span class='kw-2'>&</span><span class='ident'>FromLiteral</span>::<span class='ident'>Char</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 = "macrohelper";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>