codgenhelp 0.0.1

Simplifies structure and enum parsing in Macros1.1
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

<!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="API documentation for the Rust `Structure` enum in crate `macrohelper`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, Structure">

    <title>macrohelper::bodykind::structure::Structure - Rust</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">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        
        <p class='location'><a href='../../index.html'>macrohelper</a>::<wbr><a href='../index.html'>bodykind</a>::<wbr><a href='index.html'>structure</a></p><script>window.sidebarCurrent = {name: 'Structure', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </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 enum">
<h1 class='fqn'><span class='in-band'>Enum <a href='../../index.html'>macrohelper</a>::<wbr><a href='../index.html'>bodykind</a>::<wbr><a href='index.html'>structure</a>::<wbr><a class='enum' href=''>Structure</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../../src/macrohelper/bodykind/structure.rs.html#23-41' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Structure {
    NormalStruct(<a class='struct' href='../../../macrohelper/bodykind/field/struct.Fields.html' title='macrohelper::bodykind::field::Fields'>Fields</a>),
    TupleStruct(<a class='struct' href='../../../macrohelper/bodykind/field/struct.Fields.html' title='macrohelper::bodykind::field::Fields'>Fields</a>),
    Unit,
    Discriminant(<a class='enum' href='../../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>),
}</pre><div class='docblock'><p>There are multiple <em>types</em> of structures in Rust.</p>
</div><h2 class='variants'>Variants</h2>
<span id='variant.NormalStruct' class='variant'><span id='NormalStruct.v' class='invisible'><code>NormalStruct(<a class='struct' href='../../../macrohelper/bodykind/field/struct.Fields.html' title='macrohelper::bodykind::field::Fields'>Fields</a>)</code></span></span><div class='docblock'><p>The normal structure which has several fields</p>

<p>Example: <code>pub struct AStruct{ a: u64, b: u64 }</code></p>
</div><span id='variant.TupleStruct' class='variant'><span id='TupleStruct.v' class='invisible'><code>TupleStruct(<a class='struct' href='../../../macrohelper/bodykind/field/struct.Fields.html' title='macrohelper::bodykind::field::Fields'>Fields</a>)</code></span></span><div class='docblock'><p>A tuple struct which is just a named tuple</p>

<p>Example: <code>pub struct AStruct( u64, u64);</code></p>
</div><span id='variant.Unit' class='variant'><span id='Unit.v' class='invisible'><code>Unit</code></span></span><div class='docblock'><p>A structure that contains no data</p>

<p>Example: <code>pub struct ZeroSizedStruct;</code></p>
</div><span id='variant.Discriminant' class='variant'><span id='Discriminant.v' class='invisible'><code>Discriminant(<a class='enum' href='../../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>)</code></span></span><div class='docblock'><p>Literal Value</p>

<p>A structure cannot actually be this type. But Enum&#39;s as they can be declared with a
constant value.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/macrohelper/bodykind/structure.rs.html#42-103' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from_syn_variant' class='method'><span id='from_syn_variant.v' class='invisible'><code>fn <a href='#method.from_syn_variant' class='fnname'>from_syn_variant</a>(x: &amp;SynVariant) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>&gt;</code></span></h4>
<div class='docblock'><p>Build a structure from <code>syn</code>&#39;s representation</p>
</div><h4 id='method.from_variantdata' class='method'><span id='from_variantdata.v' class='invisible'><code>fn <a href='#method.from_variantdata' class='fnname'>from_variantdata</a>(x: &amp;VariantData) -&gt; <a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a></code></span></h4>
<div class='docblock'><p>Build a structure from <code>syn</code>&#39;s representation</p>
</div><h4 id='method.from_body' class='method'><span id='from_body.v' class='invisible'><code>fn <a href='#method.from_body' class='fnname'>from_body</a>(x: &amp;Body) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>&gt;</code></span></h4>
<div class='docblock'><p>Build from <code>syn</code>&#39;s Body representation</p>
</div><h4 id='method.is_unit' class='method'><span id='is_unit.v' class='invisible'><code>fn <a href='#method.is_unit' class='fnname'>is_unit</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></span></h4>
<h4 id='method.is_norm' class='method'><span id='is_norm.v' class='invisible'><code>fn <a href='#method.is_norm' class='fnname'>is_norm</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></span></h4>
<h4 id='method.is_tuple' class='method'><span id='is_tuple.v' class='invisible'><code>fn <a href='#method.is_tuple' class='fnname'>is_tuple</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></span></h4>
<h4 id='method.is_discriminant' class='method'><span id='is_discriminant.v' class='invisible'><code>fn <a href='#method.is_discriminant' class='fnname'>is_discriminant</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></span></h4>
<h4 id='method.get_fields' class='method'><span id='get_fields.v' class='invisible'><code>fn <a href='#method.get_fields' class='fnname'>get_fields</a>&lt;'a&gt;(&amp;'a self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;'a <a class='struct' href='../../../macrohelper/bodykind/field/struct.Fields.html' title='macrohelper::bodykind::field::Fields'>Fields</a>&gt;</code></span></h4>
<div class='docblock'><p>Get Fields</p>

<p>Returns Fields if this Struct is a Tuple or Normal</p>
</div><h4 id='method.get_literal' class='method'><span id='get_literal.v' class='invisible'><code>fn <a href='#method.get_literal' class='fnname'>get_literal</a>&lt;'a&gt;(&amp;'a self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;'a <a class='enum' href='../../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>&gt;</code></span></h4>
<div class='docblock'><p>Get Literal</p>

<p>Returns the literal value if this is a Discrimninat structure</p>
</div><h4 id='method.from_literal' class='method'><span id='from_literal.v' class='invisible'><code>fn <a href='#method.from_literal' class='fnname'>from_literal</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;<a class='enum' href='../../../macrohelper/enum.FromLiteral.html' title='macrohelper::FromLiteral'>FromLiteral</a>&gt;</code></span></h4>
<div class='docblock'><p>Get From Literal</p>

<p>Pre-Perform the conversion</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/macrohelper/bodykind/structure.rs.html#22' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class='method'><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class='method'><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='enum' href='../../../macrohelper/bodykind/structure/enum.Structure.html' title='macrohelper::bodykind::structure::Structure'>Structure</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/macrohelper/bodykind/structure.rs.html#22' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class='method'><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div></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>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</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>