mirror of
https://github.com/fluencelabs/parity-wasm
synced 2025-06-26 05:02:03 +00:00
12 lines
14 KiB
HTML
12 lines
14 KiB
HTML
|
<!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 `SignatureBuilder` struct in crate `parity_wasm`."><meta name="keywords" content="rust, rustlang, rust-lang, SignatureBuilder"><title>parity_wasm::builder::SignatureBuilder - 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">☰</div><p class='location'>Struct SignatureBuilder</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_param">with_param</a><a href="#method.with_params">with_params</a><a href="#method.with_return_type">with_return_type</a><a href="#method.param">param</a><a href="#method.params">params</a><a href="#method.return_type">return_type</a><a href="#method.build">build</a><a href="#method.build_sig">build_sig</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: 'SignatureBuilder', 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=''>SignatureBuilder</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'>−</span>]</a></span><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#13-16' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct SignatureBuilder<F = <a class="struct" href="../../parity_wasm/builder/struct.Identity.html" title="struct parity_wasm::builder::Identity">Identity</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>Signature builder</p>
|
|||
|
|
</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.SignatureBuilder.html" title="struct parity_wasm::builder::SignatureBuilder">SignatureBuilder</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/code.rs.html#18-23' 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>() -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#20-22' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>New signature builder</p>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<F> <a class="struct" href="../../parity_wasm/builder/struct.SignatureBuilder.html" title="struct parity_wasm::builder::SignatureBuilder">SignatureBuilder</a><F> <span class="where fmt-newline">where<br> F: Invoke<<a class="struct" href="../../parity_wasm/elements/struct.FunctionType.html" title="struct parity_wasm::elements::FunctionType">FunctionType</a>>, </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/code.rs.html#25-76' 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) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#27-32' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>New builder with callback function specified</p>
|
|||
|
|
</div><h4 id='method.with_param' class="method"><span id='with_param.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_param' class='fnname'>with_param</a>(self, value_type: <a class="enum" href="../../parity_wasm/elements/enum.ValueType.html" title="enum parity_wasm::elements::ValueType">ValueType</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#35-38' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add argument to signature builder</p>
|
|||
|
|
</div><h4 id='method.with_params' class="method"><span id='with_params.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_params' class='fnname'>with_params</a>(self, value_types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../../parity_wasm/elements/enum.ValueType.html" title="enum parity_wasm::elements::ValueType">ValueType</a>>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#41-44' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add multiple arguments to signature builder</p>
|
|||
|
|
</div><h4 id='method.with_return_type' class="method"><span id='with_return_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_return_type' class='fnname'>with_return_type</a>(self, return_type: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../parity_wasm/elements/enum.ValueType.html" title="enum parity_wasm::elements::ValueType">ValueType</a>>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#47-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Override signature return type</p>
|
|||
|
|
</div><h4 id='method.param' class="method"><span id='param.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.param' class='fnname'>param</a>(self) -> ValueTypeBuilder<Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start build new argument</p>
|
|||
|
|
</div><h4 id='method.params' class="method"><span id='params.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.params' class='fnname'>params</a>(self) -> ValueTypesBuilder<Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#58-60' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start build multiple arguments</p>
|
|||
|
|
</div><h4 id='method.return_type' class="method"><span id='return_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.return_type' class='fnname'>return_type</a>(self) -> OptionalValueTypeBuilder<Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#63-65' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start building return type</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) -> F::Result</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#68-70' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Finish current builder</p>
|
|||
|
|
</div><h4 id='method.build_sig' class="method"><span id='build_sig.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build_sig' class='fnname'>build_sig</a>(self) -> Signature</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/parity_wasm/builder/code.rs.html#73-75' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Finish current builder returning intermediate <code>Signature</code> struct</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<F> <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.SignatureBuilder.html" title="struct parity_wasm::builder::SignatureBuilder">SignatureBuilder</a><F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </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<F> <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.SignatureBuilder.html" title="struct parity_wasm::builder::SignatureBuilder">SignatureBuilder</a><F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </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>⏎</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>
|