codgenhelp 0.0.1

Simplifies structure and enum parsing in Macros1.1
Documentation
<!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 `HashTag` enum in crate `macrohelper`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, HashTag">

    <title>macrohelper::meta::HashTag - 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'>meta</a></p><script>window.sidebarCurrent = {name: 'HashTag', 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'>meta</a>::<wbr><a class='enum' href=''>HashTag</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/meta.rs.html#24-44' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum HashTag {
    Word(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>),
    List(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a>&lt;<a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a>&gt;&gt;),
    NameValue(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='enum' href='../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>),
    Literal(<a class='enum' href='../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>),
}</pre><div class='docblock'><p>For arguments within <code>#[derive ...]</code> tag</p>
</div><h2 class='variants'>Variants</h2>
<span id='variant.Word' class='variant'><span id='Word.v' class='invisible'><code>Word(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>)</code></span></span><div class='docblock'><p>The name of a MetaItem.</p>

<p><code>#[test]</code> will return <code>MetaItem::Word(&quot;Test&quot;)</code></p>
</div><span id='variant.List' class='variant'><span id='List.v' class='invisible'><code>List(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a>&lt;<a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a>&gt;&gt;)</code></span></span><div class='docblock'><p>A list of values</p>

<p><code>#[derive(Copy,Clone)]</code> will return
<code>MetaItem::List(&quot;derive&quot;,vec![Box::new(MetaItem::Word(&quot;Copy&quot;)),Box::new(MetaItem::Word(&quot;Clone&quot;))])</code></p>
</div><span id='variant.NameValue' class='variant'><span id='NameValue.v' class='invisible'><code>NameValue(<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='enum' href='../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>)</code></span></span><div class='docblock'><p>An assigned value</p>

<p><code>#[feature = &quot;thing&quot;]</code> will return <code>MetaItem::NameValue(&quot;feature&quot;, Literal::Str)</code></p>
</div><span id='variant.Literal' class='variant'><span id='Literal.v' class='invisible'><code>Literal(<a class='enum' href='../../macrohelper/enum.Lit.html' title='macrohelper::Lit'>Lit</a>)</code></span></span><div class='docblock'><p>A literal</p>

<p>This isn&#39;t a <em>first level</em> item. It can be encountered within
<code>MetaItem::List(_, vec![])</code> part. It is included to prevent
defining a whole extra type like <code>syn</code> does.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/macrohelper/meta.rs.html#55-138' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class='method'><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(x: &amp;MetaItem) -&gt; <a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a></code></span></h4>
<div class='docblock'><p>Build a hashtag from a metatime</p>
</div><h4 id='method.complete' class='method'><span id='complete.v' class='invisible'><code>fn <a href='#method.complete' class='fnname'>complete</a>(x: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;[</a>Attribute<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -&gt; <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;<a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a>&gt;</code></span></h4>
<div class='docblock'><p>Borrow Attribute value and parse</p>
</div><h4 id='method.is_word' class='method'><span id='is_word.v' class='invisible'><code>fn <a href='#method.is_word' class='fnname'>is_word</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_list' class='method'><span id='is_list.v' class='invisible'><code>fn <a href='#method.is_list' class='fnname'>is_list</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_name_value' class='method'><span id='is_name_value.v' class='invisible'><code>fn <a href='#method.is_name_value' class='fnname'>is_name_value</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_literal' class='method'><span id='is_literal.v' class='invisible'><code>fn <a href='#method.is_literal' class='fnname'>is_literal</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_name' class='method'><span id='get_name.v' class='invisible'><code>fn <a href='#method.get_name' class='fnname'>get_name</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='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns the name of the <code>#[...]</code> value</p>

<p>The <code>literal</code> exists so this can technically fail
to return some</p>
</div><h4 id='method.get_name_value' class='method'><span id='get_name_value.v' class='invisible'><code>fn <a href='#method.get_name_value' class='fnname'>get_name_value</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 Assignment</p>

<p>When <code>#[hashtag = value]</code> is used
this function will return the <code>value</code>
half</p>
</div><h4 id='method.get_arg_list' class='method'><span id='get_arg_list.v' class='invisible'><code>fn <a href='#method.get_arg_list' class='fnname'>get_arg_list</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;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a><a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a>&lt;<a class='enum' href='../../macrohelper/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a>&gt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>&gt;</code></span></h4>
<div class='docblock'><p>Get List</p>

<p>Fetches the internal list if a hashtag
like <code>#[derive(Clone,Copy)]</code> Which will
return an array of the <code>[Clone,Copy]</code></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>If the hashtag has an associated literal be it
<code>NameValue</code> or <code>Literal</code> this will return that
value</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/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/macrohelper/meta.rs.html#23' 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/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</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/meta/enum.HashTag.html' title='macrohelper::meta::HashTag'>HashTag</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/macrohelper/meta.rs.html#23' 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>