wasmi/wasmi/trait.ImportResolver.html

34 lines
19 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `ImportResolver` trait in crate `wasmi`."><meta name="keywords" content="rust, rustlang, rust-lang, ImportResolver"><title>wasmi::ImportResolver - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../wasmi/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ImportResolver</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.resolve_func">resolve_func</a><a href="#tymethod.resolve_global">resolve_global</a><a href="#tymethod.resolve_memory">resolve_memory</a><a href="#tymethod.resolve_table">resolve_table</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>wasmi</a></p><script>window.sidebarCurrent = {name: 'ImportResolver', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><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='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/wasmi/imports.rs.html#22-72' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>wasmi</a>::<wbr><a class="trait" href=''>ImportResolver</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ImportResolver {
fn <a href='#tymethod.resolve_func' class='fnname'>resolve_func</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_signature: &amp;<a class="struct" href="../wasmi/struct.Signature.html" title="struct wasmi::Signature">Signature</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.FuncRef.html" title="struct wasmi::FuncRef">FuncRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.resolve_global' class='fnname'>resolve_global</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.GlobalDescriptor.html" title="struct wasmi::GlobalDescriptor">GlobalDescriptor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.GlobalRef.html" title="struct wasmi::GlobalRef">GlobalRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.resolve_memory' class='fnname'>resolve_memory</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.MemoryDescriptor.html" title="struct wasmi::MemoryDescriptor">MemoryDescriptor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.MemoryRef.html" title="struct wasmi::MemoryRef">MemoryRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.resolve_table' class='fnname'>resolve_table</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.TableDescriptor.html" title="struct wasmi::TableDescriptor">TableDescriptor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.TableRef.html" title="struct wasmi::TableRef">TableRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;;
}</pre></div><div class='docblock'><p>Resolver of a module's dependencies.</p>
<p>A module have dependencies in a form of a list of imports (i.e.
tuple of a (<code>module_name</code>, <code>field_name</code>, <code>descriptor</code>)).</p>
<p>The job of implementations of this trait is to provide on each
import a corresponding concrete reference.</p>
<p>For simple use-cases you can use <a href="struct.ImportsBuilder.html"><code>ImportsBuilder</code></a>.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.resolve_func' class='method'><code id='resolve_func.v'>fn <a href='#tymethod.resolve_func' class='fnname'>resolve_func</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;_module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;_signature: &amp;<a class="struct" href="../wasmi/struct.Signature.html" title="struct wasmi::Signature">Signature</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.FuncRef.html" title="struct wasmi::FuncRef">FuncRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code></h3><div class='docblock'><p>Resolve a function.</p>
<p>Returned function should match given <code>signature</code>, i.e. all parameter types and return value should have exact match.
Otherwise, link-time error will occur.</p>
</div><h3 id='tymethod.resolve_global' class='method'><code id='resolve_global.v'>fn <a href='#tymethod.resolve_global' class='fnname'>resolve_global</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.GlobalDescriptor.html" title="struct wasmi::GlobalDescriptor">GlobalDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.GlobalRef.html" title="struct wasmi::GlobalRef">GlobalRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code></h3><div class='docblock'><p>Resolve a global variable.</p>
<p>Returned global should match given <code>descriptor</code>, i.e. type and mutability
should match. Otherwise, link-time error will occur.</p>
</div><h3 id='tymethod.resolve_memory' class='method'><code id='resolve_memory.v'>fn <a href='#tymethod.resolve_memory' class='fnname'>resolve_memory</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.MemoryDescriptor.html" title="struct wasmi::MemoryDescriptor">MemoryDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.MemoryRef.html" title="struct wasmi::MemoryRef">MemoryRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code></h3><div class='docblock'><p>Resolve a memory.</p>
<p>Returned memory should match requested memory (described by the <code>descriptor</code>),
i.e. initial size of a returned memory should be equal or larger than requested memory.
Furthermore, if requested memory have maximum size, returned memory either should have
equal or larger maximum size or have no maximum size at all.
If returned memory doesn't match the requested then link-time error will occur.</p>
</div><h3 id='tymethod.resolve_table' class='method'><code id='resolve_table.v'>fn <a href='#tymethod.resolve_table' class='fnname'>resolve_table</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;descriptor: &amp;<a class="struct" href="../wasmi/struct.TableDescriptor.html" title="struct wasmi::TableDescriptor">TableDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.TableRef.html" title="struct wasmi::TableRef">TableRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code></h3><div class='docblock'><p>Resolve a table.</p>
<p>Returned table should match requested table (described by the <code>descriptor</code>),
i.e. initial size of a returned table should be equal or larger than requested table.
Furthermore, if requested memory have maximum size, returned memory either should have
equal or larger maximum size or have no maximum size at all.
If returned table doesn't match the requested then link-time error will occur.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-ImportResolver' class='impl'><code class='in-band'>impl&lt;'a&gt; ImportResolver for <a class="struct" href="../wasmi/struct.ImportsBuilder.html" title="struct wasmi::ImportsBuilder">ImportsBuilder</a>&lt;'a&gt;</code><a href='#impl-ImportResolver' class='anchor'></a><a class='srclink' href='../src/wasmi/imports.rs.html#146-190' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.resolve_func' class="method hidden"><code id='resolve_func.v-1'>fn <a href='#method.resolve_func' class='fnname'>resolve_func</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;signature: &amp;<a class="struct" href="../wasmi/struct.Signature.html" title="struct wasmi::Signature">Signature</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.FuncRef.html" title="struct wasmi::FuncRef">FuncRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code><a class='srclink' href='../src/wasmi/imports.rs.html#147-156' title='goto source code'>[src]</a></h4><h4 id='method.resolve_global' class="method hidden"><code id='resolve_global.v-1'>fn <a href='#method.resolve_global' class='fnname'>resolve_global</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;global_type: &amp;<a class="struct" href="../wasmi/struct.GlobalDescriptor.html" title="struct wasmi::GlobalDescriptor">GlobalDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.GlobalRef.html" title="struct wasmi::GlobalRef">GlobalRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code><a class='srclink' href='../src/wasmi/imports.rs.html#158-167' title='goto source code'>[src]</a></h4><h4 id='method.resolve_memory' class="method hidden"><code id='resolve_memory.v-1'>fn <a href='#method.resolve_memory' class='fnname'>resolve_memory</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;memory_type: &amp;<a class="struct" href="../wasmi/struct.MemoryDescriptor.html" title="struct wasmi::MemoryDescriptor">MemoryDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.MemoryRef.html" title="struct wasmi::MemoryRef">MemoryRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code><a class='srclink' href='../src/wasmi/imports.rs.html#169-178' title='goto source code'>[src]</a></h4><h4 id='method.resolve_table' class="method hidden"><code id='resolve_table.v-1'>fn <a href='#method.resolve_table' class='fnname'>resolve_table</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;module_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;field_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;table_type: &amp;<a class="struct" href="../wasmi/struct.TableDescriptor.html" title="struct wasmi::TableDescriptor">TableDescriptor</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../wasmi/struct.TableRef.html" title="struct wasmi::TableRef">TableRef</a>, <a class="enum" href="../wasmi/enum.Error.html" title="enum wasmi::Error">Error</a>&gt;</code><a class='srclink' href='../src/wasmi/imports.rs.html#180-189' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/wasmi/trait.ImportResolver.js">
</script></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 = "wasmi";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>