Files
parity-wasm/parity_wasm/builder/struct.ModuleBuilder.html

76 lines
30 KiB
HTML
Raw Normal View History

2018-10-05 14:36:05 +00:00
<!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 `ModuleBuilder` struct in crate `parity_wasm`."><meta name="keywords" content="rust, rustlang, rust-lang, ModuleBuilder"><title>parity_wasm::builder::ModuleBuilder - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Struct ModuleBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_callback">with_callback</a><a href="#method.with_module">with_module</a><a href="#method.with_sections">with_sections</a><a href="#method.with_section">with_section</a><a href="#method.with_signatures">with_signatures</a><a href="#method.push_function">push_function</a><a href="#method.push_memory">push_memory</a><a href="#method.push_table">push_table</a><a href="#method.push_signature">push_signature</a><a href="#method.push_signatures">push_signatures</a><a href="#method.push_import">push_import</a><a href="#method.push_export">push_export</a><a href="#method.function">function</a><a href="#method.memory">memory</a><a href="#method.table">table</a><a href="#method.functions">functions</a><a href="#method.with_export">with_export</a><a href="#method.with_import">with_import</a><a href="#method.import">import</a><a href="#method.with_global">with_global</a><a href="#method.with_table">with_table</a><a href="#method.export">export</a><a href="#method.global">global</a><a href="#method.with_data_segment">with_data_segment</a><a href="#method.data">data</a><a href="#method.build">build</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>parity_wasm</a>::<wbr><a href='index.html'>builder</a></p><script>window.sidebarCurrent = {name: 'ModuleBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>parity_wasm</a>::<wbr><a href='index.html'>builder</a>::<wbr><a class="struct" href=''>ModuleBuilder</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/parity_wasm/builder/module.rs.html#10-13' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ModuleBuilder&lt;F&nbsp;=&nbsp;<a class="struct" href="../../parity_wasm/builder/struct.Identity.html" title="struct parity_wasm::builder::Identity">Identity</a>&gt; { /* fiel
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../parity_wasm/builder/struct.ModuleBuilder.html" title="struct parity_wasm::builder::ModuleBuilder">ModuleBuilder</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#140-145' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#142-144' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>New empty module builder</p>
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;F&gt; <a class="struct" href="../../parity_wasm/builder/struct.ModuleBuilder.html" title="struct parity_wasm::builder::ModuleBuilder">ModuleBuilder</a>&lt;F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: Invoke&lt;<a class="struct" href="../../parity_wasm/elements/struct.Module.html" title="struct parity_wasm::elements::Module">Module</a>&gt;,&nbsp;</span></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#147-397' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.with_callback' class="method"><span id='with_callback.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_callback' class='fnname'>with_callback</a>(callback: F) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#149-154' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>New module builder with bound callback</p>
</div><h4 id='method.with_module' class="method"><span id='with_module.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_module' class='fnname'>with_module</a>(self, module: <a class="struct" href="../../parity_wasm/elements/struct.Module.html" title="struct parity_wasm::elements::Module">Module</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#157-160' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Builder from raw module</p>
</div><h4 id='method.with_sections' class="method"><span id='with_sections.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_sections' class='fnname'>with_sections</a>&lt;I&gt;(self, sections: I) -&gt; Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>&lt;Item = <a class="enum" href="../../parity_wasm/elements/enum.Section.html" title="enum parity_wasm::elements::Section">Section</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#163-168' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fill module with sections from iterator</p>
</div><h4 id='method.with_section' class="method"><span id='with_section.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_section' class='fnname'>with_section</a>(self, section: <a class="enum" href="../../parity_wasm/elements/enum.Section.html" title="enum parity_wasm::elements::Section">Section</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#171-174' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add additional section</p>
</div><h4 id='method.with_signatures' class="method"><span id='with_signatures.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_signatures' class='fnname'>with_signatures</a>(self, bindings: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Signature&gt;) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#177-180' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Binds to the type section, creates additional types when required</p>
</div><h4 id='method.push_function' class="method"><span id='push_function.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_function' class='fnname'>push_function</a>(&amp;mut self, func: <a class="struct" href="../../parity_wasm/builder/struct.FunctionDefinition.html" title="struct parity_wasm::builder::FunctionDefinition">FunctionDefinition</a>) -&gt; CodeLocation</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#185-204' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push stand-alone function definition, creating sections, signature and code blocks
in corresponding sections.
<code>FunctionDefinition</code> can be build using <code>builder::function</code> builder</p>
</div><h4 id='method.push_memory' class="method"><span id='push_memory.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_memory' class='fnname'>push_memory</a>(&amp;mut self, memory: MemoryDefinition) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#207-216' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push linear memory region</p>
</div><h4 id='method.push_table' class="method"><span id='push_table.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_table' class='fnname'>push_table</a>(&amp;mut self, table: <a class="struct" href="../../parity_wasm/builder/struct.TableDefinition.html" title="struct parity_wasm::builder::TableDefinition">TableDefinition</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#219-228' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push table</p>
</div><h4 id='method.push_signature' class="method"><span id='push_signature.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_signature' class='fnname'>push_signature</a>(&amp;mut self, signature: Signature) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#250-252' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push one function signature, returning it's calling index.
Can create corresponding type in type section.</p>
</div><h4 id='method.push_signatures' class="method"><span id='push_signatures.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_signatures' class='fnname'>push_signatures</a>(&amp;mut self, signatures: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Signature&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#255-259' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push signatures in the module, returning corresponding indices of pushed signatures</p>
</div><h4 id='method.push_import' class="method"><span id='push_import.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_import' class='fnname'>push_import</a>(&amp;mut self, import: <a class="struct" href="../../parity_wasm/elements/struct.ImportEntry.html" title="struct parity_wasm::elements::ImportEntry">ImportEntry</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#263-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push import entry to module. Not that it does not update calling indices in
function bodies.</p>
</div><h4 id='method.push_export' class="method"><span id='push_export.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.push_export' class='fnname'>push_export</a>(&amp;mut self, export: <a class="struct" href="../../parity_wasm/elements/struct.ExportEntry.html" title="struct parity_wasm::elements::ExportEntry">ExportEntry</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#272-275' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Push export entry to module.</p>
</div><h4 id='method.function' class="method"><span id='function.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.function' class='fnname'>function</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.FunctionBuilder.html" title="struct parity_wasm::builder::FunctionBuilder">FunctionBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#278-280' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add new function using dedicated builder</p>
</div><h4 id='method.memory' class="method"><span id='memory.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.memory' class='fnname'>memory</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.MemoryBuilder.html" title="struct parity_wasm::builder::MemoryBuilder">MemoryBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#283-285' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add new linear memory using dedicated builder</p>
</div><h4 id='method.table' class="method"><span id='table.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.table' class='fnname'>table</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.TableBuilder.html" title="struct parity_wasm::builder::TableBuilder">TableBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#288-290' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add new table using dedicated builder</p>
</div><h4 id='method.functions' class="method"><span id='functions.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.functions' class='fnname'>functions</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.SignaturesBuilder.html" title="struct parity_wasm::builder::SignaturesBuilder">SignaturesBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#293-295' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Define functions section</p>
</div><h4 id='method.with_export' class="method"><span id='with_export.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_export' class='fnname'>with_export</a>(self, entry: <a class="struct" href="../../parity_wasm/elements/struct.ExportEntry.html" title="struct parity_wasm::elements::ExportEntry">ExportEntry</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#298-301' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>With inserted export entry</p>
</div><h4 id='method.with_import' class="method"><span id='with_import.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_import' class='fnname'>with_import</a>(self, entry: <a class="struct" href="../../parity_wasm/elements/struct.ImportEntry.html" title="struct parity_wasm::elements::ImportEntry">ImportEntry</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#304-307' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>With inserted import entry</p>
</div><h4 id='method.import' class="method"><span id='import.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.import' class='fnname'>import</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.ImportBuilder.html" title="struct parity_wasm::builder::ImportBuilder">ImportBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#324-326' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Import entry builder</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">parity_wasm</span>::<span class="ident">builder</span>::<span class="ident">module</span>;
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">module</span>()
.<span class="ident">import</span>()
.<span class="ident">module</span>(<span class="string">&quot;env&quot;</span>)
.<span class="ident">field</span>(<span class="string">&quot;memory&quot;</span>)
.<span class="ident">external</span>().<span class="ident">memory</span>(<span class="number">256</span>, <span class="prelude-val">Some</span>(<span class="number">256</span>))
.<span class="ident">build</span>()
.<span class="ident">build</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">import_section</span>().<span class="ident">expect</span>(<span class="string">&quot;import section to exist&quot;</span>).<span class="ident">entries</span>().<span class="ident">len</span>(), <span class="number">1</span>);</pre>
</div><h4 id='method.with_global' class="method"><span id='with_global.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_global' class='fnname'>with_global</a>(self, global: <a class="struct" href="../../parity_wasm/elements/struct.GlobalEntry.html" title="struct parity_wasm::elements::GlobalEntry">GlobalEntry</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#329-332' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>With global variable</p>
</div><h4 id='method.with_table' class="method"><span id='with_table.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_table' class='fnname'>with_table</a>(self, table: <a class="struct" href="../../parity_wasm/elements/struct.TableType.html" title="struct parity_wasm::elements::TableType">TableType</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#335-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>With table</p>
</div><h4 id='method.export' class="method"><span id='export.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.export' class='fnname'>export</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.ExportBuilder.html" title="struct parity_wasm::builder::ExportBuilder">ExportBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#359-361' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Export entry builder</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">parity_wasm</span>::<span class="ident">builder</span>::<span class="ident">module</span>;
<span class="kw">use</span> <span class="ident">parity_wasm</span>::<span class="ident">elements</span>::<span class="ident">Instruction</span>::<span class="kw-2">*</span>;
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">module</span>()
.<span class="ident">global</span>()
.<span class="ident">value_type</span>().<span class="ident">i32</span>()
.<span class="ident">init_expr</span>(<span class="ident">I32Const</span>(<span class="number">0</span>))
.<span class="ident">build</span>()
.<span class="ident">export</span>()
.<span class="ident">field</span>(<span class="string">&quot;_zero&quot;</span>)
.<span class="ident">internal</span>().<span class="ident">global</span>(<span class="number">0</span>)
.<span class="ident">build</span>()
.<span class="ident">build</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">export_section</span>().<span class="ident">expect</span>(<span class="string">&quot;export section to exist&quot;</span>).<span class="ident">entries</span>().<span class="ident">len</span>(), <span class="number">1</span>);</pre>
</div><h4 id='method.global' class="method"><span id='global.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.global' class='fnname'>global</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.GlobalBuilder.html" title="struct parity_wasm::builder::GlobalBuilder">GlobalBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#378-380' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Glboal entry builder</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">parity_wasm</span>::<span class="ident">builder</span>::<span class="ident">module</span>;
<span class="kw">use</span> <span class="ident">parity_wasm</span>::<span class="ident">elements</span>::<span class="ident">Instruction</span>::<span class="kw-2">*</span>;
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">module</span>()
.<span class="ident">global</span>()
.<span class="ident">value_type</span>().<span class="ident">i32</span>()
.<span class="ident">init_expr</span>(<span class="ident">I32Const</span>(<span class="number">0</span>))
.<span class="ident">build</span>()
.<span class="ident">build</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">global_section</span>().<span class="ident">expect</span>(<span class="string">&quot;global section to exist&quot;</span>).<span class="ident">entries</span>().<span class="ident">len</span>(), <span class="number">1</span>);</pre>
</div><h4 id='method.with_data_segment' class="method"><span id='with_data_segment.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_data_segment' class='fnname'>with_data_segment</a>(self, segment: <a class="struct" href="../../parity_wasm/elements/struct.DataSegment.html" title="struct parity_wasm::elements::DataSegment">DataSegment</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#383-386' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add data segment to the builder</p>
</div><h4 id='method.data' class="method"><span id='data.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.data' class='fnname'>data</a>(self) -&gt; <a class="struct" href="../../parity_wasm/builder/struct.DataSegmentBuilder.html" title="struct parity_wasm::builder::DataSegmentBuilder">DataSegmentBuilder</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#389-391' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Data entry builder</p>
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>(self) -&gt; F::Result</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/module.rs.html#394-396' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Build module (final step)</p>
</div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;F&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../parity_wasm/builder/struct.ModuleBuilder.html" title="struct parity_wasm::builder::ModuleBuilder">ModuleBuilder</a>&lt;F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;F&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../parity_wasm/builder/struct.ModuleBuilder.html" title="struct parity_wasm::builder::ModuleBuilder">ModuleBuilder</a>&lt;F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,&nbsp;</span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "parity_wasm";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>