mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
26 lines
13 KiB
HTML
26 lines
13 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 `wasmer_runtime_core` crate."><meta name="keywords" content="rust, rustlang, rust-lang, wasmer_runtime_core"><title>wasmer_runtime_core - 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="https://wasmer.io/static/icons/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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><a href='../wasmer_runtime_core/index.html'><div class='logo-container'><img src='https://avatars3.githubusercontent.com/u/44205449?s=200&v=4' alt='logo'></div></a><p class='location'>Crate wasmer_runtime_core</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all wasmer_runtime_core's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'wasmer_runtime_core', ty: 'mod', relpath: '../'};</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'>−</span>]</a></span><a class='srclink' href='../src/wasmer_runtime_core/lib.rs.html#1-173' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>wasmer_runtime_core</a></span></h1><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
||
<table><tr><td><code>pub use <a class="mod" href="../wasmer_runtime_core/trampoline_x64/index.html" title="mod wasmer_runtime_core::trampoline_x64">trampoline_x64</a> as trampoline;</code></td></tr><tr><td><code>pub use <a class="mod" href="../wasmparser/index.html" title="mod wasmparser">wasmparser</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='module-item'><td><a class="mod" href="cache/index.html" title='wasmer_runtime_core::cache mod'>cache</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="codegen/index.html" title='wasmer_runtime_core::codegen mod'>codegen</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="error/index.html" title='wasmer_runtime_core::error mod'>error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="export/index.html" title='wasmer_runtime_core::export mod'>export</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="fault/index.html" title='wasmer_runtime_core::fault mod'>fault</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="global/index.html" title='wasmer_runtime_core::global mod'>global</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="import/index.html" title='wasmer_runtime_core::import mod'>import</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="instance/index.html" title='wasmer_runtime_core::instance mod'>instance</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="loader/index.html" title='wasmer_runtime_core::loader mod'>loader</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="memory/index.html" title='wasmer_runtime_core::memory mod'>memory</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="module/index.html" title='wasmer_runtime_core::module mod'>module</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="parse/index.html" title='wasmer_runtime_core::parse mod'>parse</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="prelude/index.html" title='wasmer_runtime_core::prelude mod'>prelude</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="state/index.html" title='wasmer_runtime_core::state mod'>state</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="structures/index.html" title='wasmer_runtime_core::structures mod'>structures</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="table/index.html" title='wasmer_runtime_core::table mod'>table</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="trampoline_x64/index.html" title='wasmer_runtime_core::trampoline_x64 mod'>trampoline_x64</a></td><td class='docblock-short'><p>Trampoline generator for carrying context with function pointer.</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="typed_func/index.html" title='wasmer_runtime_core::typed_func mod'>typed_func</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="types/index.html" title='wasmer_runtime_core::types mod'>types</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="units/index.html" title='wasmer_runtime_core::units mod'>units</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="vm/index.html" title='wasmer_runtime_core::vm mod'>vm</a></td><td class='docblock-short'></td></tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
||
<table><tr class='module-item'><td><a class="macro" href="macro.debug.html" title='wasmer_runtime_core::debug macro'>debug</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="macro" href="macro.func.html" title='wasmer_runtime_core::func macro'>func</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="macro" href="macro.imports.html" title='wasmer_runtime_core::imports macro'>imports</a></td><td class='docblock-short'><p>Generate an <a href="struct.ImportObject.html"><code>ImportObject</code></a> safely.</p>
|
||
</td></tr><tr class='module-item'><td><a class="macro" href="macro.trace.html" title='wasmer_runtime_core::trace macro'>trace</a></td><td class='docblock-short'></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.DynFunc.html" title='wasmer_runtime_core::DynFunc struct'>DynFunc</a></td><td class='docblock-short'><p>A representation of an exported WebAssembly function.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Func.html" title='wasmer_runtime_core::Func struct'>Func</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Instance.html" title='wasmer_runtime_core::Instance struct'>Instance</a></td><td class='docblock-short'><p>An instantiated WebAssembly module.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Module.html" title='wasmer_runtime_core::Module struct'>Module</a></td><td class='docblock-short'><p>A compiled WebAssembly module.</p>
|
||
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
||
<table><tr class='module-item'><td><a class="constant" href="constant.VERSION.html" title='wasmer_runtime_core::VERSION constant'>VERSION</a></td><td class='docblock-short'><p>The current version of this crate</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.IsExport.html" title='wasmer_runtime_core::IsExport trait'>IsExport</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.compile_with.html" title='wasmer_runtime_core::compile_with fn'>compile_with</a></td><td class='docblock-short'><p>Compile a <a href="struct.Module.html"><code>Module</code></a> using the provided compiler from
|
||
WebAssembly binary code. This function is useful if it
|
||
is necessary to a compile a module before it can be instantiated
|
||
and must be used if you wish to use a different backend from the default.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.compile_with_config.html" title='wasmer_runtime_core::compile_with_config fn'>compile_with_config</a></td><td class='docblock-short'><p>The same as <code>compile_with</code> but changes the compiler behavior
|
||
with the values in the <code>CompilerConfig</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.load_cache_with.html" title='wasmer_runtime_core::load_cache_with fn'>load_cache_with</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.validate.html" title='wasmer_runtime_core::validate fn'>validate</a></td><td class='docblock-short'><p>Perform validation as defined by the
|
||
WebAssembly specification. Returns <code>true</code> if validation
|
||
succeeded, <code>false</code> if validation failed.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.validate_and_report_errors.html" title='wasmer_runtime_core::validate_and_report_errors fn'>validate_and_report_errors</a></td><td class='docblock-short'><p>The same as <code>validate</code> but with an Error message on failure</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.validate_and_report_errors_with_features.html" title='wasmer_runtime_core::validate_and_report_errors_with_features fn'>validate_and_report_errors_with_features</a></td><td class='docblock-short'><p>The same as <code>validate_and_report_errors</code> but with a Features.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='wasmer_runtime_core::Result type'>Result</a></td><td class='docblock-short'></td></tr></table></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 = "wasmer_runtime_core";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |